nodejs / nodejs/changelog-maker
What about templating, or deep configuration, or simple API?
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 236
- Forks
- 41
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 7
Description
I'm going to try http://keepachangelog.com/ and need some tiny improvements for autogenerating CHANGELOG.md.
As I see:
- Need to parse somehow CHANGELOG.md to get sections with commits list;
- Remove already added commit from import;
- Split commits list to different sections;
- Generate new release section for unreleased section since last tag (or since passed --start-ref).
- Replace old unreleased with the new one.
Also it can be an option to finalize unreleased section with some tag (in that way we need to fetch 2 tags: previous and the last, and use them as start and end refs).
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
Start by reading the existing changelog generation flow and its command-line options, especially --start-ref. Define how CHANGELOG.md sections, commit removal, unreleased replacement, and tag-based finalization should interact; done means the requested workflows are specified and covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100