https://github.com/moox/github-release-from-changelog
Create GitHub releases from your changelog
https://github.com/moox/github-release-from-changelog
Last synced: about 1 year ago
JSON representation
Create GitHub releases from your changelog
- Host: GitHub
- URL: https://github.com/moox/github-release-from-changelog
- Owner: MoOx
- License: mit
- Created: 2015-10-03T22:31:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-13T00:26:55.000Z (almost 3 years ago)
- Last Synced: 2025-04-03T00:09:12.118Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 246 KB
- Stars: 64
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# github-release-from-changelog
[](https://github.com/MoOx/github-release-from-changelog/actions)
[](https://www.npmjs.com/package/github-release-from-changelog)
> 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](https://github.com/MoOx/github-release-from-changelog/blob/master/github-release-from-changelog.js) 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 `GITHUB_TOKEN` as an env var. See for instructions.
_Included in [npmpub](https://github.com/MoOx/npmpub) !_
## Install
```console
npm install github-release-from-changelog
```
## Usage
```console
github-release-from-changelog [--filename CustomChangelog.md]
```
### Options
#### `--filename`
Specify your own filename
#### `--dryRun`
Test what the release will looks like
#### `--debug`
Display parsing information
## Advanced Installation and Usage
github-release-from-changelog is fully integrated in [npmpub](https://github.com/MoOx/npmpub).
Please follow the instructions at to install and use it.
npmpub automatically calls github-release-from-changelog by default.
github-release-from-changelog also plays well with other publishing tools such as [release-it](https://www.npmjs.com/package/release-it).
One can create a release using release-it (which also updates `package.json`, but does not free you from maintaining `CHANGELOG.md` for yourself) and then use github-release-from-changelog to create the release on GitHub.
## CONTRIBUTING
- ⇄ Pull requests and ★ Stars are always welcome.
- For bugs and feature requests, please create an issue.
## CHANGELOG
See [CHANGELOG.md](CHANGELOG.md)
## LICENSE
The license is MIT.
See [LICENSE](LICENSE).