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 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 https://github.com/MoOx/npmpub#requirements for instructions.

Included in npmpub !

Install

npm install github-release-from-changelog

Usage

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. Please follow the instructions at https://github.com/MoOx/npmpub#install 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. 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

LICENSE

The license is MIT. See LICENSE.

github-release-from-changelog Changelog

2.1.1 - 2020-02-18

• Bump dependency triggering warning
  [GitHub API] Deprecation notice for authentication via URL query parameters

2.1.0 - 2019-09-20

• 😂 Fix a specific bug if a line contain a version similar to supported markdown title
• 🎉 We now show a direct link to the release

2.0.0 - 2019-09-20

🥳 Less contraints!

Now we support multiples version format like

• # X.Y.Z
• ## X.Y.Z
• ## vX.Y.Z
• ## [vX.Y.Z
• ## [X.Y.Z

(This means no more code specific to https://keepachangelog.com & more flexibility)

1.3.2 - 2018-06-07

• Upgrade of grizzly to prevent security issue by @ntwb

1.3.1 - 2018-01-22

• Fix "Keep A Changelog" version detection by @igetgames

1.3.0 - 2017-12-06

• Add support for auto-determing different CHANGELOG filenames, by @koppor, reported by @MoOx (in #6)
• Add support for format of "Keep a Changelog", by @koppor

1.2.1 - 2016-06-28

• Fixed: Empty value for parameter 'tag_name': undefined

1.2.0 - 2016-06-28

• Changed: use grizzly v2.x (ref node-grizzly#1)

1.1.4 - 2016-06-07

• Fixed: TypeError: Cannot read property 'createRelease' of undefined by fixing grizzly version. (#12)

1.1.3 - 2016-02-12

• Fixed: chmod +x ./github-release-from-changelog.js

1.1.2 - 2016-02-12

• Fixed: tag starting with "v" are now compatible. (#9)

1.1.1 - 2016-01-06

• Fixed: blank line are not stripped for block anymore (which can break markdown rendering - eg: title using ## ) (#7)

1.1.0 - 2015-11-10

• Added: --filename option to specify your own filename (if you don't use CHANGELOG.md).

1.0.0 - 2015-10-04

✨ Initial release