semantic-release

GitHub Action to run semantic-release with the DHIS2 customizations and extensions in place.

In addition to the ready-made semantic-release plugins:

• commit-analyzer
• release-notes-generator
• changelog
• npm
• git
• github

We have a few custom plugins that we use:

• defer-release
• update-deps
• apphub

Usage

Create a workflow, or use an example from dhis2/workflows as a base.

To use in an existing workflow, add the action to a step after the build process:

- uses: dhis2/action-semantic-release@master
  with:
      github-token: ${{ env.GH_TOKEN }}

It is possible to lock the action version by referencing a tag in the uses statement, e.g.: dhis2/action-semantic-release@1.2.1.

We use GH_TOKEN and not GITHUB_TOKEN to distinguish between the user who pushed (GITHUB_TOKEN) and the PAT of the account (GH_TOKEN) that we want to trigger the release.

Options

See the action.yml file for an overview of the configuration possibilities. In DHIS2 scenarios, the defaults should be sane.

Assets

Some assets are committed with the release commit:

• API.md and **/API.md
• yarn.lock and **/yarn.lock
• package.json and **/package.json
• CHANGELOG.md