feat: improve changelogs page #1274
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- by default only show releases notes of installed version - menu to select and read `latest`, `beta`, etc - linkify the mentions and pr number similar to github
There was a problem hiding this comment.
Pull Request Overview
This PR improves the changelogs page by introducing a version selector menu and leveraging the GitHub API to fetch and display different types of release notes. Key changes include:
- Replacing the static changelog fetch with dynamic GitHub API calls.
- Introducing a context menu for selecting release versions (current, latest, beta, or full).
- Enhancing the rendered markdown to linkify PR numbers and mentions.
Files not reviewed (1)
- src/pages/changelog/style.scss: Language not supported
Comments suppressed due to low confidence (1)
src/pages/changelog/changelog.js:67
- The /latest endpoint returns a single release object while other functions expect an array of releases from the GitHub API. Verify that the response format is consistent across endpoints or handle the differences appropriately.
const releases = await fsOperation(`${GITHUB_API_URL}/latest`).readFile("json",);
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR improves the changelogs page by adding version selection options and dynamically loading release notes based on the user's selection. Key changes include:
- Adding a version selector with a context menu for choosing between current, latest, beta, or full changelog views.
- Refactoring the changelog loading mechanism to retrieve release notes from both GitHub API endpoints and local changelog files.
- Enhancing markdown rendering with regex-based linkification for PR numbers and user mentions.
Files not reviewed (1)
- src/pages/changelog/style.scss: Language not supported
Comments suppressed due to low confidence (2)
src/pages/changelog/changelog.js:75
- [nitpick] Consider logging error details (e.g., via console.error) within the catch block to facilitate debugging without exposing sensitive information to end-users.
$content.innerHTML = '<div class="error">Failed to load latest release notes</div>';
src/pages/changelog/changelog.js:103
- [nitpick] Consider using a consistent naming format (e.g., 'CHANGELOG' or 'Full Changelog') for the version display to avoid potential confusion with file names.
selectedVersion = "Changelogs.md";
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
latest,beta, etc release notesScreenshots