Skip to content

feat: improve changelogs page#1274

Merged
bajrangCoder merged 4 commits intoAcode-Foundation:mainfrom
bajrangCoder:changelog-page-improvements
Apr 22, 2025
Merged

feat: improve changelogs page#1274
bajrangCoder merged 4 commits intoAcode-Foundation:mainfrom
bajrangCoder:changelog-page-improvements

Conversation

@bajrangCoder
Copy link
Copy Markdown
Member

  • by default only show releases notes of installed version
  • menu to select and read latest, beta, etc release notes
  • linkify the mentions and pr number similar to github

Screenshots

Screenshot_20250422-164248
Screenshot_20250422-164231

- 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
@bajrangCoder bajrangCoder requested a review from Copilot April 22, 2025 11:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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",);

Comment thread src/pages/changelog/changelog.js
bajrangCoder and others added 2 commits April 22, 2025 16:54
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@bajrangCoder bajrangCoder requested a review from Copilot April 22, 2025 11:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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";

@bajrangCoder bajrangCoder merged commit fdbf2e5 into Acode-Foundation:main Apr 22, 2025
2 checks passed
@bajrangCoder bajrangCoder deleted the changelog-page-improvements branch May 9, 2025 16:26
@Acode-Foundation Acode-Foundation locked as spam and limited conversation to collaborators Dec 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants