microsoft / microsoft/beachball
Rebuild the changelog after adding customRenderer
Open
Nobody has claimed this yet.
feature
- Dominant language
- TypeScript
- Stars
- 815
- Forks
- 93
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 12
Description
I added a renderEntry to my beachball customRenderers and I can see it create new entries with that renderer.
Is there a command to rebuild my CHANGELOG.md files from the CHANGELOG.json so all the entries will have the new format?
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 with the customRenderer definition in src/types/ChangelogOptions.ts and trace how CHANGELOG.json is converted into CHANGELOG.md files. Check the existing changelog or release entry points for a rebuild path; done means users can regenerate existing changelogs with the custom renderer, or the supported command is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100