scratchfoundation/scratch-semantic-release-config
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-semantic-release-config.git synced 2025-03-23 19:32:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
semantic-release shareable configuration for Scratch
25 commits 12 branches 19 tags 5.1 MiB
Find a file
Jed Mao df5b02ffff docs: summarize expectations in README
2019-07-31 00:29:39 -05:00
.editorconfig feat: initial release 2019-06-11 14:01:53 -05:00
.gitignore feat: initial release 2019-06-11 14:01:53 -05:00
.npmrc feat: initial release 2019-06-11 14:01:53 -05:00
.releaserc.json fix: release notes after changelog title 2019-06-11 17:32:11 -05:00
.travis.yml feat: initial release 2019-06-11 14:01:53 -05:00
CHANGELOG.md chore(release): 1.0.6 [skip ci] 2019-06-26 17:11:32 +00:00
LICENSE Initial commit 2019-06-11 13:05:37 -05:00
package.json chore(release): 1.0.6 [skip ci] 2019-06-26 17:11:32 +00:00
README.md docs: summarize expectations in README 2019-07-31 00:29:39 -05:00

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.