voxpupuli/semantic-release

voxpupuli/semantic-release repository overview

⁠Voxpupuli Semantic Release Container

⁠Introduction

This container can be used to create project releases. It encapsulates semantic-release⁠ and all necessary plugins. See package.json⁠ for details. This is a npm application running in an alpine container.

⁠Usage

Main tools in the container:

conventional-changelog
semantic-release
commit-and-tag-version

for more information see the package.json⁠

⁠Running the tools

# semantic-release is the default entrypoint
podman run -it --rm -v $PWD:/data:Z ghcr.io/voxpupuli/semantic-release:latest

# run commit-and-tag-version
podman run -it --rm -v $PWD:/data:Z --entrypoint commit-and-tag-version ghcr.io/voxpupuli/semantic-release:latest -r v2.0.0 --skip.commit --skip.tag

# run conventional-changelog
podman run -it --rm -v $PWD:/data:Z --entrypoint conventional-changelog ghcr.io/voxpupuli/semantic-release:latest -p angular -i CHANGELOG.md

⁠Variables

The container has the following pre-defined environment variables:

Variable	Default
CERT_JSON	no default
PATH	`$PATH:/npm/node_modules/.bin`
NODE_OPTIONS	`--use-openssl-ca`
ROCKETCHAT_EMOJI	`:tada:`
ROCKETCHAT_MESSAGE_TEXT	`A new tag for the project ${CI_PROJECT_NAME} was created by ${CI_COMMIT_AUTHOR}.`
ROCKETCHAT_HOOK_URL	`https://rocketchat.example.com/hooks/here_be_dragons`
ROCKETCHAT_TAGS_URL	`${CI_PROJECT_URL}/-/tags`
MATTERMOST_EMOJI	`:tada:`
MATTERMOST_MESSAGE_TEXT	`A new tag for the project ${CI_PROJECT_NAME} was created by ${CI_COMMIT_AUTHOR}.`
MATTERMOST_HOOK_URL	`https://mattermost.example.com/hooks/here_be_dragons`
MATTERMOST_TAGS_URL	`${CI_PROJECT_URL}/-/tags`
MATTERMOST_USERNAME	`Semantic Release`

⁠Example `.releaserc.yaml`

This is an example configuration file for a project using semantic-release.

---
branches:
 - 'main'
 - 'master'
 - 'production'

ci: true
debug: true
dryRun: false
preset: 'conventionalcommits'

gitlabUrl: 'https://gitlab.example.com'
gitlabApiPathPrefix: '/api/v4'

plugins:
  - path: '@semantic-release/commit-analyzer'
    releaseRules:
      - { breaking: true, release: major }
      - { type: build,    release: patch }
      - { type: chore,    release: false }
      - { type: ci,       release: false }
      - { type: dep,      release: patch }
      - { type: docs,     release: patch }
      - { type: feat,     release: minor }
      - { type: fix,      release: patch }
      - { type: perf,     release: patch }
      - { type: refactor, release: false }
      - { type: revert,   release: patch }
      - { type: test,     release: false }

  - path: '@semantic-release/release-notes-generator'
    writerOpts:
      groupBy: 'type'
      commitGroupsSort: 'title'
      commitsSort: 'header'
    parserOpts:
      # detect JIRA issues in merge commits
      issuePrefixes: ['SUP', 'BUG', 'FEATURE']
      noteKeywords: ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
    presetConfig:
      issueUrlFormat: "https://jira.example.com/browse/{{prefix}}{{id}}"
      types:
        - { type: 'build',    section: '👷 Build' }
        - { type: 'chore',    section: '🧹 Chores' }
        - { type: 'ci',       section: '🚦 CI/CD' }
        - { type: 'dep',      section: '👾 Dependencies' }
        - { type: 'docs',     section: '📚 Docs' }
        - { type: 'feat',     section: '🚀 Features' }
        - { type: 'fix',      section: '🛠️ Fixes' }
        - { type: 'perf',     section: '⏩ Performance' }
        - { type: 'refactor', section: '🔨 Refactor' }
        - { type: 'revert',   section: '🙅 Reverts' }
        - { type: 'test',     section: '🚥 Tests' }

  - path: '@semantic-release/changelog'
    changelogFile: 'CHANGELOG.md'

  - path: '@semantic-release/git'
    assets:
      - 'CHANGELOG.md'

verifyConditions:
  - '@semantic-release/changelog'
  - '@semantic-release/git'

⁠Example `.versionrc.json`

This is an example configuration file for a project using commit-and-tag-version.

{
  "types": [
    { "type": "build",    "section": "👷 Build" },
    { "type": "chore",    "section": "🧹 Chores" },
    { "type": "ci",       "section": "🚦 CI/CD" },
    { "type": "dep",      "section": "👾 Dependencies" },
    { "type": "docs",     "section": "📚 Docs" },
    { "type": "feat",     "section": "🚀 Features" },
    { "type": "fix",      "section": "🛠️ Fixes" },
    { "type": "perf",     "section": "⏩ Performance" },
    { "type": "refactor", "section": "🔨 Refactor" },
    { "type": "revert",   "section": "🙅 Reverts" },
    { "type": "test",     "section": "🚥 Tests" }
  ]
}

⁠Update metadata.json of a Puppet module

This refers to the example config from above...

plugins:
#...
  - path: 'semantic-release-replace-plugin'
    replacements:
      - files: ['metadata.json']
        from: "\"version\": \".*\""
        to: "\"version\": \"${nextRelease.version}\""
        countMatches: true
        results:
          - file: 'metadata.json'
            hasChanged: true
            numMatches: 1
            numReplacements: 1
#...
  - path: '@semantic-release/git'
    assets:
      # ...
      - 'metadata.json'

⁠Gitlab

This is a example to use this container in Gitlab. It requires, that you have:

A .releaserc file, written in YAML or JSON, with optional extensions: .yaml / .yml / .json / .js / .cjs / .mjs
A release.config.(js|cjs|.mjs) file that exports an object
A release key in the project's package.json file

---
release:
  stage: Release🚀
  image:
    name: ghcr.io/voxpupuli/semantic-release:latest
    entrypoint: [""]  # overwrite entrypoint - gitlab-ci quirk
    pull_policy:
      - always
      - if-not-present
  interruptible: true
  script:
    - /container-entrypoint.sh
  rules:
    - if: $CI_COMMIT_BRANCH == "master"
    - if: $CI_COMMIT_BRANCH == "main"
    - if: $CI_COMMIT_BRANCH == "production"

⁠Running as local user

When using git+ssh remotes, you might encounter issues accessing your git server.

This solution launches your local ssh-agent (if it's not already running) and adds your default SSH key. It then sets an environment variable within the container to locate the ssh-agent socket. It also bind-mounts the socket from your host system into the container, enabling secure access to your git server.

eval $(ssh-agent)
ssh-add

podman run -it --rm \
  -v $PWD:/data:Z \
  -v ~/.gitconfig:/etc/gitconfig:Z \
  -v ~/.ssh:/root/.ssh:Z \
  -v ${SSH_AUTH_SOCK}:${SSH_AUTH_SOCK} \
  -e SSH_AUTH_SOCK="${SSH_AUTH_SOCK}" \
  ghcr.io/voxpupuli/semantic-release:latest --dry-run --no-ci

⁠Notifying

⁠RocketChat

There is a helper script in the container, which can send some data over curl to RocketChat. You need a RocketChat hook link.

The script has the parameters -V, -o and -d.

-V specifies the version which should be announced.
-o can specify optional extra curl parameters. Like for example --insecure.
-d turn on debug output.

The script accesses the environment variables:

ROCKETCHAT_EMOJI
ROCKETCHAT_MESSAGE_TEXT
ROCKETCHAT_TAGS_URL
ROCKETCHAT_HOOK_URL

⁠Mattermost

There is a helper script in the container, which can send some data over curl to Mattermost. You need a Mattermost hook link.

The script has the parameters -V, -o and -d.

-V specifies the version which should be announced.
-o can specify optional extra curl parameters. Like for example --insecure.
-d turn on debug output.

The script accesses the environment variables:

MATTERMOST_EMOJI
MATTERMOST_MESSAGE_TEXT
MATTERMOST_TAGS_URL
MATTERMOST_HOOK_URL
MATTERMOST_USERNAME

⁠.releaserc.yaml

---
# ...
plugins:
# Most people will choose between one of those two:
# ...
  - path: '@semantic-release/exec'
    publishCmd: "/scripts/notify-rocketchat.sh -V v${nextRelease.version} -o '--insecure' -d"
# ...
  - path: '@semantic-release/exec'
    publishCmd: "/scripts/notify-mattermost.sh -V v${nextRelease.version} -o '--insecure' -d"
# ...

⁠.gitlab-ci.yml

---
release:
# Most people will choose between one of those two:
# ...
  variables:
    ROCKETCHAT_NOTIFY_TOKEN: "Some hidden CI Variable to not expose the token"
    ROCKETCHAT_EMOJI: ":tada:"
    ROCKETCHAT_MESSAGE_TEXT: "A new tag for the project ${CI_PROJECT_NAME} was created by ${GITLAB_USER_NAME}"
    ROCKETCHAT_HOOK_URL: "https://rocketchat.example.com/hooks/${ROCKETCHAT_NOTIFY_TOKEN}"
    ROCKETCHAT_TAGS_URL: "${CI_PROJECT_URL}/-/tags"
# ...
    MATTERMOST_NOTIFY_TOKEN: "Some hidden CI Variable to not expose the token"
    MATTERMOST_EMOJI: ":tada:"
    MATTERMOST_MESSAGE_TEXT: "A new tag for the project ${CI_PROJECT_NAME} was created by ${GITLAB_USER_NAME}"
    MATTERMOST_HOOK_URL: "https://mattermost.example.com/hooks/${MATTERMOST_NOTIFY_TOKEN}"
    MATTERMOST_TAGS_URL: "${CI_PROJECT_URL}/-/tags"
    MATTERMOST_USERNAME: "Semantic Release [Bot]"
# ...

15:07 🤖 bot-account:
A new tag for the project dummy-module was created by Jon Doe.
Release v1.2.3

⁠Adding additional certificates to the container

If you somehow need own certificates inside the container, you can add them over the entrypoint script.

For example: you want to run the a webhook on a target with your own ca certificates. Export the CERT_JSON and the container will import it on runtime. It is expected that the certificates are a json hash of PEM certificates. It is preferable that the json is uglified into a onliner.

You may add this as a CI Variable for your runners on Github/Gitlab.

{"certificates":{"root_ca":"-----BEGIN CERTIFICATE-----\n...","signing_ca":"-----BEGIN CERTIFICATE-----\n..."}}

For more details have a look at container-entrypoint.sh⁠ and container-entrypoint.d⁠.

Tag summary

Recent tags

Content type

Image

Digest

sha256:df5b3b124…

Size

120 MB

Last updated

about 3 hours ago

docker pull voxpupuli/semantic-release

This week's pulls

Pulls:

187

Last week

Learn more⁠