scratchfoundation/scratch-semantic-release-config
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-semantic-release-config.git synced 2024-11-23 07:58:23 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
scratch-semantic-release-co.../README.md
Jed Mao df5b02ffff docs: summarize expectations in README
2019-07-31 00:29:39 -05:00

2.6 KiB
Raw Blame History

@jedmao/semantic-release-npm-github-config

semantic-release shareable config to publish npm packages with GitHub.

Travis npm version

Plugins

This shareable configuration uses the following plugins:

Summary

  • Provides an informative git commit message for the release commit that does not trigger continuous integration and conforms to the conventional commits specification (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
  • Creates a tarball that gets uploaded with each GitHub release.
  • Publishes the same tarball to npm.
  • Commits the version change in package.json.
  • Creates or updates a changelog file.

Install

$ npm install --save-dev semantic-release @jedmao/semantic-release-npm-github-config

Usage

The shareable config can be configured in the semantic-release configuration file:

{
  "extends": "@jedmao/semantic-release-npm-github-config",
  "branch": "master"
}

Configuration

Ensure that your CI configuration has the following secret environment variables set:

See each plugin documentation for required installation and configuration steps.