Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable show release notes #6306

Open
2 tasks
timtmok opened this issue Feb 11, 2025 · 1 comment
Open
2 tasks

Enable show release notes #6306

timtmok opened this issue Feb 11, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@timtmok
Copy link
Contributor

timtmok commented Feb 11, 2025

The code to show release notes has been disabled by default. This means that the action is hidden and release notes are not shown after an update.

It's possible to retrieve the release notes from the GitHub release description and parse it for the release notes section. The GitHub API does not require an access token for retrieving the release by tag name. https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#get-a-release-by-tag-name

  • Update product contribution (update.ts) to use Positron versions when deciding whether to show release notes
  • Update releaseNotesEditor.ts#loadReleaseNotes to retrieve release description for version and parse it for release notes
@timtmok timtmok added the enhancement New feature or request label Feb 11, 2025
@timtmok timtmok added this to the Future milestone Feb 11, 2025
@timtmok timtmok self-assigned this Feb 11, 2025
@juliasilge
Copy link
Contributor

Related to #5722 where we outline some of our aspirations around release notes.

Note that we do not intend to have the GitHub release description be where we have human readable, nice release notes.

@juliasilge juliasilge modified the milestones: Future, Post-RC Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants