semantic-release-config

Turo configuration for semantic-release

Install

Via NPM:

npm install --save-dev semantic-release @open-turo/semantic-release-config

Or yarn:

yarn add --dev semantic-release @open-turo/semantic-release-config

Presets

• Default. Include all changes in the release notes. Allow next releases from branches that start with f/, b/ or c/
• Gradle. All the default configuration in addition to updating the gradle.properties file
• NPM. All the default configuration in addition to publishing packages to NPM and updates assets like package.json
• OpenAPI. All the default configuration in addition to updating the gradle.properties and OpenAPI spec files.

Usage

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

{
  "extends": "@open-turo/semantic-release-config"
}

If you are not using the default preset, you have to specify its name too:

{
  "extends": "@open-turo/semantic-release-config/npm"
}

Available presets: npm, gradle, gradle-and-npm, openapi.

See more details about how shareable configurations can be created in here.

Configuration

This plugin requires no configuration, but certain environment variables need to be present in order for some of the plugins to work correctly.

Default

• GITHUB_TOKEN. A GitHub token so the Github release can be created
• SEMANTIC_RELEASE_JIRA_SERVER_URL. Jira instance URL (e.g. https://your-company.atlassian.net). When unset, the Jira plugin is a noop. See Jira integration below.
• SEMANTIC_RELEASE_JIRA_USERNAME / SEMANTIC_RELEASE_JIRA_API_TOKEN. Optional. Required only for write operations (issue transitions, version creation) and to fetch issue titles for release notes.

Gradle

• GITHUB_TOKEN. When a new release is published, this plugin will try to commit and push into the released branch. Ensure that the user that is running the release has push rights and can bypass branch protection rules (see here)

NPM

• GITHUB_TOKEN. When a new release is published, this plugin will try to commit and push into the released branch. Ensure that the user that is running the release has push rights and can bypass branch protection rules (see here)
• NPM_TOKEN. A NPM token so the package can be published to NPM (a .npmrc file with extra configuration can also be used)

OpenAPI

• GITHUB_TOKEN. When a new release is published, this plugin will try to commit and push into the released branch. Ensure that the user that is running the release has push rights and can bypass branch protection rules (see here)

Jira integration

All presets include @open-turo/semantic-release-jira, which collects Jira issue references from commits, branch names, and PR descriptions, and appends a ## Jira Issues section to the release notes.

The plugin is configured entirely via environment variables (no configuration is provided in this preset), so each consuming repository can opt into the level of integration it needs:

• Disabled (noop). Don't set any SEMANTIC_RELEASE_JIRA_* variables. The plugin runs but does nothing.
• Read-only. Set SEMANTIC_RELEASE_JIRA_SERVER_URL. Issue keys in commits / branches / PRs are linked in the release notes.
• Authenticated read. Also set SEMANTIC_RELEASE_JIRA_USERNAME and SEMANTIC_RELEASE_JIRA_API_TOKEN. Release notes include issue titles in addition to links.
• Write mode. Add SEMANTIC_RELEASE_JIRA_TRANSITION_ISSUES=true to move issues to Done, and/or SEMANTIC_RELEASE_JIRA_CREATE_VERSIONS=true to create Jira versions. Write operations only run on default branch releases (skips prereleases).

See the plugin README for the full list of supported environment variables.

@semantic-release/exec

This preset includes @semantic-release/exec to run custom scripts. It supports scripts for the publish, success and fail hooks.

The convention is that the configuration will run the script if there is an executable file like ./script/semantic-release-<hook>.

These scripts must follow the convention of the @semantic-release/exec plugin (e.g. in the publish hook, the release information can be written to stdout as parseable JSON, but nothing else).

If there is no file, then this plugin will be a noop.

Scripts don't receive any argument.

Development

Install pre-commit and the commit hooks:

pre-commit install
pre-commit install --hook-type commit-msg

Get Help

Please review Issues, post new Issues against this repository as needed.

Contributions

Please see here for guidelines on how to contribute to this project.