@bubkoo/semantic-release-config

Sharable configuration for semantic-release, extends experience for publishing to NPM & Github

Usage no npm install needed!

<script type="module">
  import bubkooSemanticReleaseConfig from 'https://cdn.skypack.dev/@bubkoo/semantic-release-config';
</script>

README

semantic-release-config

semantic-release shareable configuration for npm & GitHub

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 @bubkoo/semantic-release-config

Usage

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

{
  "extends": "@bubkoo/semantic-release-config"
}

License

The scripts and documentation in this project are released under the MIT License