github-release-from-changelog
<a href="https://github.com/MoOx/react-from-svg?sponsor=1" <img width="140" align="right" alt="Sponsoring button" src="https://github.com/moox/.github/raw/main/FUNDING.svg" </a
[](https://github.com/MoOx) [](https://www.linkedin.com/in/maxthirouin/) [](https://bsky.app/profile/moox.io) [](https://x.com/MoOx)
Create GitHub releases from CHANGELOG.md
This tool edits the git tag on GitHub and create a GitHub release with the correct changelog section.
You need:
- a changelog file (various filenames supported automatically or specified via --filename option) with markdown titles that start with the version (eg: # 1.2.0, ## v1.2.0, # [1.2.0...)
- a package.json with a version field.
- a git tag with the corresponding version in either X.Y.Z or vX.Y.Z formats.
- a GITHUBTOKEN as an env var. See <https://github.com/MoOx/npmpub#requirements for instructions.
Included in npmpub !
Install
npm install github-release-from-changelogUsage
github-release-from-changelog [--filename CustomChangelog.md]Options
#### --filename
Specify your own filename
#### --dryRun
Test what the release will looks like
#### --debug