semantic-release

What is it

We often use semantic-release in differents CI systems like Gitlab & Github. In order to reduce the effort of setting up and maintaining a lot of pipelines, we use this image as starting point for semantic-release.

How to use

Nothing simpler than this. Just run docker run docker.pkg.github.com/caos/semantic-release/semantic-release:latest semantic-release. The last command semantic-release is important. Because the entrypoint in the docker images points to npx.

Gitlab CI

You can use the image as stage e.g version. We usualy use the only: - branches option so that it not triggers itself. To run it, simply pass npx semantic-release along.

semantic_release:
  stage: version
  image: docker.pkg.github.com/caos/semantic-release/semantic-release:latest
  only:
    - branches
  script:
    - npx semantic-release

Github Actions

To use this this image with Github Actions you can create a step which invokes the command npx semantic-release within the image.

jobs:
  semantic-release:
      runs-on: ubuntu-18.04
    steps:
    - name: Source checkout
      uses: actions/checkout@v1
    - name: Create Version
      uses: caos/[email protected]
    - name: Check if Version Tag is available
      if: env.CAOS_NEXT_VERSION == ''
      run: exit 1

For --dry-run just pass the argument to substitute the CMD command from the image.

jobs:
  semantic-release:
      runs-on: ubuntu-18.04
    steps:
    - name: Source checkout
      uses: actions/checkout@v1
    - name: Create Version
      uses: caos/[email protected]
      args: "semantic-release --dry-run"

If you would like to use the generated version in later steps, just use the env. var $CAOS_NEXT_VERSION with the .releaserc.js example below.

module.exports = {
    branch: 'master',
    plugins: [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/github",
        ["@semantic-release/exec", {
            "prepareCmd": "echo '::set-env name=CAOS_NEXT_VERSION::v${nextRelease.version}'"
            }],
    ]
  };

License

As usual Apache-2.0 see here