feat: include changelog release notes in GitHub releases#22768
Open
workharsh99 wants to merge 1 commit into
Open
feat: include changelog release notes in GitHub releases#22768workharsh99 wants to merge 1 commit into
workharsh99 wants to merge 1 commit into
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| - name: Extract Release Notes | ||
| if: steps.tag.outputs.pkgName | ||
| run: | | ||
| node scripts/extractReleaseNotes.js ${{ steps.tag.outputs.pkgName }} ${{ github.ref_name }} .github/release-notes.md |
| - name: Extract Release Notes | ||
| if: steps.tag.outputs.pkgName | ||
| run: | | ||
| node scripts/extractReleaseNotes.js ${{ steps.tag.outputs.pkgName }} ${{ github.ref_name }} .github/release-notes.md |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Currently, Vite release notes on GitHub only contain a link directing users to the
CHANGELOG.mdfile. Other repositories in the organization (such as Vitest, Rolldown, Oxc) include the actual notes in the release itself, which is much better for tools like Dependabot and general readability.This PR updates the release workflow to extract the specific section of the release notes from the package's
CHANGELOG.mdfile and populate the GitHub Release body directly.Changes
Created
scripts/extractReleaseNotes.js:CHANGELOG.mdand extracts the release section matching the version.../../docs/public/...) to absolute URLs pointing to the repository tag so they render correctly on GitHub releases.Modified
.github/workflows/release-tag.yml:yyx990803/release-tagaction input frombodytobody_pathreferencing the generated.github/release-notes.md.Verification & Testing
v8.1.0and confirming correct formatting.v8.0.0tag, confirming that the relative announcement image path../../docs/public/og-image-announcing-vite8.webpwas successfully rewritten to:https://github.com/vitejs/vite/blob/v8.0.0/docs/public/og-image-announcing-vite8.webp