@immediate_media/semantic-release-config

semantic-release-config

Kill all humans.

This package contains a shareable configuration for semantic-release, which is used to help automate publication of our packages. It is designed to be run from AWS CodeBuild.

Features:

• Publishes JavaScript packages to npm.
• Tags the git repo.
• Adds release notes to the git repo.
• Adds a CHANGELOG to the git repo.
• Provides support or canary releases

Installation

yarn add -D semantic-release @immediate_media/semantic-release-config

Usage

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

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

Plugins

The configuration uses the following plugins:

• @semantic-release/commit-analyzer
• @semantic-release/exec
• @semantic-release/github
• @semantic-release/npm
• @semantic-release/release-notes-generator
• @semantic-release/changelog
• @semantic-release/git

Canary Releases

On occasion, we may want to publish a version of our package to the registry containing an incomplete feature so that we can incrementally adopt and experiment with this feature in specific places, without risking this code being pulled in by anyone who installs or updates the package.

For this purpose we can create a canary release

• Create a branch with a name in the format canary/fab-123.
• Push commits to this branch as normal; they will be published to npm with the dist tag fab-123 (instead of the default of latest).
• Once published this version can be installed in your consuming application with yarn add @immediate_media/my-pkg@feat-123.
• When you're ready to release your feature for real open an PR to merge your canary branch back into the default branch.