release.config.js

// Generic release configuration.
//
// Required parameters are:
// 1. KIRA_RELEASE_ASSETS
//    to release static files with gitlab
// 2. CI_PROJECT_NAMESPACE and CI_PROJECT_NAME
//    to correctly set name of your docker image
//    if you are using docker releases
//
// See README.md for more options and their description.

// Configuration:
const assets = process.env.KIRA_RELEASE_ASSETS || []
const replaceConfig = JSON.parse(
  process.env.KIRA_RELEASE_REPLACE_CONFIG || '{}',
)
const execConfig = JSON.parse(process.env.KIRA_RELEASE_EXEC_CONFIG || '{}')
const skipDocker = process.env.KIRA_RELEASE_SKIP_DOCKER
const branches = JSON.parse(process.env.KIRA_RELEASE_BRANCHES || '["master", "main"]')
const includeComments = process.env.KIRA_INCLUDE_COMMENTS || 'off'

const gitlabComments = {
  'off': false,
  'issue': '<% return issue %>',
  'mergeRequest': '<% return mergeRequest %>',
  'all': '<% return issue || mergeRequest %>',
}
if (!(includeComments in gitlabComments)) {
  throw new Error(
    `Invalid value: ${includeComments} for: ${Object.keys(gitlabComments)}`,
  )
}

// Files to be committed back to the repo later on:
const toBeCommitted = ['CHANGELOG.md']
if (replaceConfig.project) {
  console.log('Found replacement configuration')
  console.log(replaceConfig)

  toBeCommitted.push(replaceConfig.project)
}

if (Object.keys(execConfig).length !== 0) {
  console.log('Found exec configuration')
  console.log(execConfig)
}

console.log('Going to commit:', toBeCommitted)

// Pipeline definition:
const releasePipeline = {
  'branches': branches,
  'plugins': [
    '@semantic-release/commit-analyzer',
    '@semantic-release/release-notes-generator',
    '@semantic-release/changelog',
  ],
}

// Maybe we should update some files with versions?
if (replaceConfig) {
  releasePipeline.plugins.push([
    'semantic-release-replace-plugin', {
      'replacements': [{
        'files': [replaceConfig.project],
        'from': replaceConfig.from,
        'to': replaceConfig.to,
        'results': [
          {
            'file': replaceConfig.project,
            'hasChanged': true,
            'numMatches': 1,
            'numReplacements': 1,
          }
        ],
        'countMatches': true,
      }],
    },
  ])
}

// We want to have this commit in a build before any `docker` stuff:
releasePipeline.plugins.push(['@semantic-release/git', { 'assets': toBeCommitted }])

// Maybe we should execute some extra steps before making a deployment?
if (Object.keys(execConfig).length !== 0) {
  releasePipeline.plugins.push([
    // See: https://github.com/semantic-release/exec
    '@semantic-release/exec', execConfig,
  ])
}

// Back to basic release pipeline:
const successComment = 'This issue has been resolved in version ${nextRelease.version} 🎉'
const gitlabConfig = {
  assets,
  successComment,
  'successCommentCondition': gitlabComments[includeComments],
}
releasePipeline.plugins.push(['@semantic-release/gitlab', gitlabConfig])

// Maybe we should crete a docker release?
// If it is not a docker-based app, this step will be ignored:
if (!skipDocker || skipDocker.toLowerCase() !== 'true') {
  const imageName = `${process.env.CI_PROJECT_NAMESPACE}/${process.env.CI_PROJECT_NAME}`
  console.log('Preparing docker image release:', imageName)
  releasePipeline.plugins.push(['kira-release', { imageName }])
} else {
  console.log(
    `Skipping docker, because KIRA_RELEASE_SKIP_DOCKER is set to ${skipDocker}`,
  )
}

module.exports = releasePipeline