GitLab CI/CD Tips: Automatic Versioning Using semantic-release

<type>(optional scope): <description>

[optional body]

[optional footer(s)]

sr_gen_releaserc_json()
{
  # Use nodejs as default project_type
  project_type="${PROJECT_TYPE:-nodejs}"
  # REGEX to match the rc_branch name
  rc_branch_regex='^release\/[0-9]\+\.[0-9]\+\.[0-9]\+$'
  # PATHS on the local ASSETS_DIR
  assets_dir="${CI_PROJECT_DIR}/${ASSETS_DIR}"
  sr_local_plugin="${assets_dir}/local-plugin.cjs"
  releaserc_tmpl="${assets_dir}/releaserc.json.tmpl"
  pipeline_runtime_values_yaml="/tmp/releaserc_values.yaml"
  pipeline_values_yaml="${assets_dir}/values_${project_type}_project.yaml"
  # Destination PATH
  releaserc_json=".releaserc.json"
  # Create an empty pipeline_values_yaml if missing
  test -f "$pipeline_values_yaml" || : >"$pipeline_values_yaml"
  # Create the pipeline_runtime_values_yaml file
  echo "branch: ${CI_COMMIT_BRANCH}" >"$pipeline_runtime_values_yaml"
  echo "gitlab_url: ${CI_SERVER_URL}" >"$pipeline_runtime_values_yaml"
  # Add the rc_branch name if we are on an rc_branch
  if [ "$(echo "$CI_COMMIT_BRANCH" | sed -ne "/$rc_branch_regex/{p}")" ]; then
    echo "rc_branch: ${CI_COMMIT_BRANCH}" >>"$pipeline_runtime_values_yaml"
  elif [ "$(echo "$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME" |
      sed -ne "/$rc_branch_regex/{p}")" ]; then
    echo "rc_branch: ${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME}" \
      >>"$pipeline_runtime_values_yaml"
  fi
  echo "sr_local_plugin: ${sr_local_plugin}" >>"$pipeline_runtime_values_yaml"
  # Create the releaserc_json file
  tmpl -f "$pipeline_runtime_values_yaml" -f "$pipeline_values_yaml" \
    "$releaserc_tmpl" | jq . >"$releaserc_json"
  # Remove the pipeline_runtime_values_yaml file
  rm -f "$pipeline_runtime_values_yaml"
  # Print the releaserc_json file
  print_file_collapsed "$releaserc_json"
  # --*-- BEG: NOTE --*--
  # Rename the package.json to ignore it when calling semantic release.
  # The idea is that the local-plugin renames it back on the first step of the
  # semantic-release process.
  # --*-- END: NOTE --*--
  if [ -f "package.json" ]; then
    echo "Renaming 'package.json' to 'package.json_disabled'"
    mv "package.json" "package.json_disabled"
  fi
}

{
  "plugins": [
    {{- if .sr_local_plugin }}
    "{{ .sr_local_plugin }}",
    {{- end }}
    [
      "@semantic-release/commit-analyzer",
      {
        "preset": "conventionalcommits",
        "releaseRules": [
          { "breaking": true, "release": "major" },
          { "revert": true, "release": "patch" },
          { "type": "feat", "release": "minor" },
          { "type": "fix", "release": "patch" },
          { "type": "perf", "release": "patch" }
        ]
      }
    ],
    {{- if .replacements }}
    [
      "semantic-release-replace-plugin",
      { "replacements": {{ .replacements | toJson }} }
    ],
    {{- end }}
    "@semantic-release/release-notes-generator",
    {{- if eq .branch "main" }}
    [
      "@semantic-release/changelog",
      { "changelogFile": "CHANGELOG.md", "changelogTitle": "# Changelog" }
    ],
    {{- end }}
    [
      "@semantic-release/git",
      {
        "assets": {{ if .assets }}{{ .assets | toJson }}{{ else }}[]{{ end }},
        "message": "ci(release): v${nextRelease.version}\n\n${nextRelease.notes}"
      }
    ],
    [
      "@semantic-release/gitlab",
      { "gitlabUrl": "{{ .gitlab_url }}", "successComment": false }
    ]
  ],
  "branches": [
    { "name": "develop", "prerelease": "SNAPSHOT" },
    {{- if .rc_branch }}
    { "name": "{{ .rc_branch }}", "prerelease": "rc" },
    {{- end }}
    "main"
  ]
}

replacements:
  - files:
      - "package.json"
    from: "\"version\": \".*\""
    to: "\"version\": \"${nextRelease.version}\""
assets:
  - "CHANGELOG.md"
  - "package.json"

git_push_setup()
{
  # Update global credentials to allow git clone & push for all the group repos
  git config --global credential.helper store
  cat >"$HOME/.git-credentials" <<EOF
https://fake-user:${GITLAB_REPOSITORY_TOKEN}@gitlab.com
EOF
  # Define user name, mail and signing key for semantic-release
  user_name="$SR_USER_NAME"
  user_email="$SR_USER_EMAIL"
  ssh_signing_key="$SSH_SIGNING_KEY"
  # Export git user variables
  export GIT_AUTHOR_NAME="$user_name"
  export GIT_AUTHOR_EMAIL="$user_email"
  export GIT_COMMITTER_NAME="$user_name"
  export GIT_COMMITTER_EMAIL="$user_email"
  # Sign commits with ssh if there is a SSH_SIGNING_KEY variable
  if [ "$ssh_signing_key" ]; then
    echo "Configuring GIT to sign commits with SSH"
    ssh_keyfile="/tmp/.ssh-id"
    : >"$ssh_keyfile"
    chmod 0400 "$ssh_keyfile"
    echo "$ssh_signing_key" | tr -d '\r' >"$ssh_keyfile"
    git config gpg.format ssh
    git config user.signingkey "$ssh_keyfile"
    git config commit.gpgsign true
  fi
}