@codedependant/release-config-npm

Baseline shareable semantic-release configuration for publishing npm packages

Usage no npm install needed!

<script type="module">
  import codedependantReleaseConfigNpm from 'https://cdn.skypack.dev/@codedependant/release-config-npm';
</script>

README

release-config-npm

Shareable semantic-release configuration for internal projects with which to publish npm packages to the internal github registry. It extends the baseline configuration.

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

Installation

$ npm install --save-dev @codedependant/release-config-npm

Usage

{
  "release": {
    "branches": ["main"],
    "extends": ["@codedependant/release-config-npm"]
  }
}

Features

  • Parse un-merged commits to determine next release version
    • The version number is dictated by the commit with the highest semver level
  • Increments the version of package.json
  • Generates + updates Changelog
    • Includes links to commit sha
    • Organizes changes by type
  • Publishes package to npm.pkg.github.com
  • Commits standardized release commit back upstream

Authors