Skip to content

Generating release notes using this #549

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.

Sign up for GitHub

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

Jump to bottom
Closed
kabirbaidhya opened this issue Jul 20, 2017 · 6 comments
Closed

Generating release notes using this #549

kabirbaidhya opened this issue Jul 20, 2017 · 6 comments
Labels
question

Comments

@kabirbaidhya
Copy link

Hi,

Is there any easier way to generate release notes using this tool? All we need is to generate the notes in the same format as the change log but only for the issues closed or PRs merged since the last release tag.

It would help a lot while drafting a new release too.
@olleolleolle
Copy link
Collaborator

olleolleolle commented Jul 20, 2017 via email

@kabirbaidhya
Copy link
Author

kabirbaidhya commented Jul 20, 2017 •
edited
Loading

@olleolleolle I tried using --since, it worked but it was showing some issues from already released tag too. I tried --since-tag as well, but the result was same.

Finally, I came across the --unreleased-only option, which is what I was looking for. It did work as expected.

$ github_changelog_generator --unreleased-only --unreleased-label=<NEXT_RELEASE_TAG>

BTW, is it possible to just print the generated output and not write to the CHANGELOG.md file? Kind of something like --dry-run or similar?

@lambdafu
Copy link

@kabirbaidhya Under Linux, you can use "-o /dev/stdout" to print it to stdout.

@skywinder
Copy link
Member

Related to #56

@bruce-szalwinski
Copy link
Contributor

BTW, is it possible to just print the generated output and not write to the CHANGELOG.md file? Kind of something like --dry-run or similar?

You can supply --output with no file name and it will write to standard out.

@bruce-szalwinski
Copy link
Contributor

You could then use release create to create the release notes from the command line!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@olleolleolle @lambdafu @bruce-szalwinski @kabirbaidhya @skywinder