github-tools / github-tools/github-release-notes
Provide a way to include the generated changelog file in the release
- 主要语言
- JavaScript
- 星标
- 897
- 派生
- 313
- PR 合并指标
- 30 天内没有已合并 PR
描述
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?
贡献指南
调研方向
首先跟踪 `gren release` 和 `gren changelog` 入口点,以及 release tarball 的创建方式。完成的标准是,release 可以将其生成的 `CHANGELOG.md` 包含在 tarball 中,而无需后续提交。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, node.js
- 领域
- cli, release
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100