Skip to content
semantic-release shareable configuration for npm + GitHub
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.gitignore feat: initial release Jun 11, 2019
.npmrc feat: initial release Jun 11, 2019
.releaserc.json fix: release notes after changelog title Jun 11, 2019
.travis.yml feat: initial release Jun 11, 2019
CHANGELOG.md chore(release): 1.0.6 [skip ci] Jun 26, 2019
LICENSE Initial commit Jun 11, 2019
README.md docs: summarize expectations in README Jul 31, 2019
package.json chore(release): 1.0.6 [skip ci] Jun 26, 2019

README.md

@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.

You can’t perform that action at this time.