github-tools / github-tools/github-release-notes
Provide a way to include the generated changelog file in the release
- Dominant language
- JavaScript
- Stars
- 897
- Forks
- 313
- PR merge metrics
- No merged PRs in 30d
Description
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?
Contributor guide
Research direction
Start by tracing the `gren release` and `gren changelog` entry points and how the release tarball is created. Done means a release can include its generated `CHANGELOG.md` in the tarball without requiring a later commit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- cli, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100