Semantic Release Config
The shared semantic release config and plugins for my projects.
Usage
Install the package:
# install the package and run semantic-release with built-in config
pnpm dlx @jcwillox/semantic-release-config
Extra args are passed straight to
semantic-release
so you can use--dry-run
or--no-ci
for example.
Environment Variables
The config is designed to be controlled through environment variables, all envs must be prefixed with SEMANTIC_RELEASE_
.
Option | Description | Default |
---|---|---|
NPM_ENABLE |
Enable/disable the npm plugin |
true when package.json exists and private is not set to true
|
NPM_PKG_ROOT |
Directory path to publish | . |
GITHUB_ASSETS |
Assets glob to upload to the GitHub release | |
GITHUB_DRAFT |
Create a draft release on GitHub | false |
FORCE_RELEASE |
Forces the specified release type to be made, one of major , minor , patch , auto
|
auto |
CMD_VERIFY |
Run a command, supports templating same as @semantic-release/exec | |
CMD_GENERATE_NOTES |
Run a command, supports templating same as @semantic-release/exec | |
CMD_PREPARE |
Run a command, supports templating same as @semantic-release/exec | |
CMD_PUBLISH |
Run a command, supports templating same as @semantic-release/exec | |
CMD_CHANNEL |
Run a command, supports templating same as @semantic-release/exec |