-
Notifications
You must be signed in to change notification settings - Fork 29
feat: ✨ add skipOnPrerelease config to not update changelog ... #290
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
feat: ✨ add skipOnPrerelease config to not update changelog ... #290
Conversation
dd97682 to
c556422
Compare
...eases When working a lot with prereleases the changelog file can become quite bloated with the prereleases To provide easier overview one might only want to include normal releases in the changelog. That is why i added the skipOnPrerelease config flag which is false by default But if you turn it on it will prevent updates on prereleases
c556422 to
8aa9784
Compare
I need this too, because with a branch operation like alpha > beta > main, the changelog in the main branch reflects all versions and if you make a lot of changes in alpha before release to main it will be very large and not very understandable.
Maybe add a feature to be able to choose the branches on which the changelog is generated?
Another possibility is to create a system to choose a file name according to the branch, for example to have CHANGELOG-beta.md if we are in the beta branch.
Do you have a workaround for now?
Thanks
casparbauer
commented
Mar 11, 2024
We are in need of configuring when the changelog is generated too. For us, a regex based approach works best, though a skipOnPrerelease would have worked for us as well. In any case, our pipeline setup requires this to be available in the NPM registry. We therefore now published a separate package which preforms an augmentation: https://www.npmjs.com/package/@flexperto/semantic-release-changelog
...on prereleases
When working a lot with prereleases the changelog file can become quite bloated with the prereleases.
To provide easier overview one might only want to include normal releases in the changelog.
That is why i added the skipOnPrerelease config flag which is false by default to not cause unexpected behavior change.
But if you turn it on it will prevent updates on prereleases and only include release change notes in the changelog.