Miss any of our Open RFC calls?Watch the recordings here! »

github-release-from-cc-changelog

2.2.0 • Public • Published

*nix build status Windows build status Tests coverage Transpilation status

github-release-from-cc-changelog

Retrieve release notes from CHANGELOG.md (as generated by standard-version) and post them to GitHub

Installation

npm i -g github-release-from-cc-changelog

Prerequisites

  • Github url needs to be configured at package.json repository field
  • Ensure GitHub access token available at CONVENTIONAL_GITHUB_RELEASER_TOKEN environment variable. The scopes for the token you need is public_repo or repo (if you need to access private repos).
  • Tags for given versions need to exist in GitHub repository before pushing release notes

Usage

CLI

At package directory run:

github-release-from-cc-changelog <version>

e.g.

github-release-from-cc-changelog 1.0.0

Resolve and publish notes for all versions

At package directory run:

github-release-all-from-cc-changelog

Dump release notes for given version

Useful also to verify whether notes for given version can be retrieved

At package directory run:

dump-release-notes-from-cc-changelog <version>

Programmatically

const releaseFromChangelog = require("github-release-from-cc-changelog");
 
releaseFromChangelog(packageDirectory, version).then(() => {
  console.log(`Successfully pushed release notes for version ${ version }`);
});

Reseolve and publish notes for all versions

const releaseAllFromChangelog = require("github-release-from-cc-changelog/all");
 
releaseFromChangelog(packageDirectory).then(() => {
  console.log(`Successfully pushed and released notes for all versions`);
});

Test

npm test

Install

npm i github-release-from-cc-changelog

DownloadsWeekly Downloads

54

Version

2.2.0

License

ISC

Unpacked Size

56 kB

Total Files

39

Last publish

Collaborators

  • avatar