This repository has been archived by the owner on May 30, 2024. It is now read-only.
fix: include prerelease in changelog only for prerelease #1003
Conversation
This file contains 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
vinistock
reviewed
Jan 25, 2024
.github/workflows/publish.yml
Outdated
| @@ -34,6 +34,7 @@ jobs: | |||
| }); | |||
|
|
|||
| const changelog = releases | |||
| .filter((release) => !release.prerelease) | |||
There was a problem hiding this comment.
With this, we always filter the prerelease entries. Can we do this only when we publish a stable release? That way, when we create a prerelease people can still see the entries related to it.
The information about whether the release being published is a prerelease or not should be available somewhere in the action's context.
There was a problem hiding this comment.
Found it in context.payload.release.prerelease let me know if it's OK like that 👍
I'll change the PR title to be more exact about the solution implemented.
There was a problem hiding this comment.
Btw, i tested here, without all the publishing steps to be sure it was ok. The cat part include well prerelease changelog for a prerelease.
snutij
force-pushed
the
fix-changelog-prerelease
branch
from
b55f825
to
d3fca8f
Compare
snutij
changed the title
vinistock
approved these changes
Jan 26, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Motivation
Closes Shopify/ruby-lsp#1673
Prerelease are included in changelog, which render something not ordered and hard to read for user.
Implementation
Filter out prerelease.
Automated Tests
N/A
Manual Tests
Same as #810, impossible to test this flow exactly to me, but I added this step in the CI workflow, you can see the result on my fork, toggle the
Catpart. No prerelease are included.