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

Dry run mode that only prints the changelog as a preview #2316

Open
fengelniederhammer opened this issue Jun 18, 2024 · 0 comments
Open

Dry run mode that only prints the changelog as a preview #2316

fengelniederhammer opened this issue Jun 18, 2024 · 0 comments
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@fengelniederhammer
Copy link

Quite often, I would like to preview the changelog that the commits in my PR will result in. It would be nice to run release-please in a mode that prints the changelog.

I imagine a GitHub Actions workflow:

  • Run release-please to generate the changelog
  • (Optionally check whether there are relevant changes)
  • Post the changelog to a comment in the PR, so that the author knows whether the next release will look as intended.

The missing bit is getting the changelog. (Sorry, if I missed an existing feature, I didn't find anything in the docs.)

Is your feature request related to a problem? Please describe.
No.

Describe the solution you'd like
A CLI flag that only prints the generated changelog would be cool. Similar to what --dry-run does, but without all the other clutter.

Describe alternatives you've considered
Using --dry-run and somehow extracting the changelog from there.

Additional context

@fengelniederhammer fengelniederhammer added priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

2 participants