Improve changelog generation workflow
Open
Nobody has claimed this yet.
area/documentation
kind/enhancement
- Dominant language
- TypeScript
- Stars
- 15.2k
- Forks
- 1.5k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 6
Description
Currently we use some automated tool that doesn't seem to work right. Our changelog is generally terrible.
Probably, the best solution is to move to a semi-automated system where a PR is tagged with its changelog text - need to look into how to do this with GHA or a bot.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or current tool is identified in the issue. Start by locating the existing automated changelog workflow, then investigate how GitHub Actions or a bot could use changelog text attached to pull requests; done means the workflow produces a more reliable changelog.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100