github-release-notes icon indicating copy to clipboard operation
github-release-notes copied to clipboard

Provide a way to include the generated changelog file in the release

Open ebousse opened this issue 7 years ago • 2 comments

To do a release with Gren, the workflow is:

  • put a tag on a commit
  • run gren release

After this is done, if one wants a textual CHANGELOG.md file, one can run gren changelog, which retrieves the description of the release from the repo and puts it into a file.

Then, if we want this generated CHANGELOG.md to be part of the repo, we add it with a commit. However, this means this file is not part of the release tarball we just made, since this new commit will come after the tag.

Could we imagine a way to be able to make a release that would include its own updated CHANGELOG.md file?

ebousse avatar Jun 07 '18 15:06 ebousse

I have the same issue. Not a huge deal but it kind of defeats the purpose of a CHANGELOG file not to have it included in the actual release, which means the release notes won't be physically present everywhere the release is actually deployed.

julesrenaud avatar Mar 19 '20 19:03 julesrenaud

You can use gren changelog --generate to create the CHANGELOG independently and then you can release it?

Does that work?

alexcanessa avatar Mar 25 '20 20:03 alexcanessa