semantic-release-additional-tags 1.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20.x'
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Semantic Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.releaserc

@@ -0,0 +1,17 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ]
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 1.0.0 (2024-01-10)
+
+
+### Performance Improvements
+
+* Initial release ([85e04e1](https://github.com/4ch3los/semantic-release-additional-tags/commit/85e04e1cf4b2dba2d88cec11ebf6b6c6f1c5e890))
+
+
+### BREAKING CHANGES
+
+* Initial commit

package/README.MD

@@ -0,0 +1,91 @@
+# semantic-release-additional-tags
+  <a href="https://www.npmjs.com/package/semantic-release-additional-tags">
+    <img alt="npm latest version" src="https://img.shields.io/npm/v/semantic-release-additional-tags/latest.svg">
+  </a>
+
+A plugin for [semantic-relese](https://github.com/semantic-release/semantic-release) inspired by [semantic-release-major-tag](https://www.npmjs.com/package/semantic-release-major-tag) but with the added option to set tags via the gitlab api to support the reuse of protected tags 
+
+
+
+## Supported Steps
+
+### verifyConditions
+
+Verifies the provided additionalTags and tests the gitlab credentials if gitlab is enabled 
+### success
+
+Adds the additional tags to the provided commit
+
+
+# Installation
+> npm i --save-dev semantic-release-additional-tags
+
+or
+> yarn add -D semantic-release-additional-tags
+
+And follow the configuration below
+
+
+# Configuration
+Every option can be set using Environment variable or the plugin config
+
+Example:
+```
+{
+  "plugins": [
+    ["semantic-release-additional-tags", {
+            
+      }
+    ]
+  ]
+}
+```
+
+
+| Config Option      | Environment variable | Required                | Default             | Description                                                                                                                     |
+|--------------------|----------------------|-------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| `additionalTags`   | -                    | Yes                     | `[]`                | String array containing the additional tags with possible variables `${major}`, `${minor}`, `${patcg}`. Ex.: `v${major}.latest` | 
+| `useGitlabApi`     | `ADDITIONAL_TAGS_GITLAB` | No                      | `false`         | Option to enable the use of the gitlab api to support retagging of protected tags                                               |
+| `gitlabToken`      | `GL_TOKEN` or `GITLAB_TOKEN` | when gitlab api is used | -           | Gitlab api token, with permissions to create/delete tags                                                                        |
+| `commitSha`        | `CI_COMMIT_SHA`         | when gitlab api is used | -                | The referenced commit to be tagged, by default provided by gitlab_ci                                                            |
+| -                  | `CI_API_V4_URL`       | No                      | -                  | URL of the v4 api endpoint of gitlab, by default provided by gitlab ci                                                          |
+| `gitlabUrl`        | `GITLAB_URL`  | No                      | `https://gitlab.com` | Base url of the used gitlab instance if `CI_API_V4_URL` is not set                                                              |
+
+# Example CI Config
+
+## Gitlab
+
+```
+stages:
+  - semantic-release
+semantic-release:
+  stage: semantic-release
+  image: node
+  before_script:
+    - npm install semantic-release
+    - npm install @semantic-release/git
+    - npm install @semantic-release/gitlab    
+    - npm install semantic-release-additional-tags
+  script:
+     # Gitlab CI Variables already set in project settings
+     # GL_TOKEN
+    - |
+      cat > .releaserc << EOF
+      {
+        "branches": ["master", "main"],
+        "debug": true,
+        "plugins": [
+          "@semantic-release/commit-analyzer",
+          "@semantic-release/gitlab",
+          ["semantic-release-additional-tags", {
+            "useGitlabApi": true,
+            "additionalTags": ["latest", "v${major}.latest", "$v{major}.${minor}.latest"]
+          }]
+        ]
+      }
+      EOF
+    - semantic-release
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH 
+      when: always
+```

package/index.js

@@ -0,0 +1,7 @@
+const verifyConditions = require('./lib/verify')
+const success = require('./lib/success')
+
+module.exports = {
+    verifyConditions,
+    success
+}

package/lib/gitlab.js

@@ -0,0 +1,43 @@
+const axios = require("axios")
+const {getEnvOrConfigOrDefault, getEnvOrConfig} = require("./util")
+
+const gitlabRequest = async (pluginConfig, method, url, options = {}) => {
+    const gitlabUrl = getEnvOrConfigOrDefault("GITLAB_URL", "gitlabUrl", pluginConfig, "https://gitlab.com")
+
+    let apiUrl
+
+    if (process.env['CI_API_V4_URL']) {
+        apiUrl = 'CI_API_V4_URL'
+    } else {
+        apiUrl = gitlabUrl + (gitlabUrl.endsWith("/") ? "" : "/") + "api/v4"
+    }
+
+    let authToken
+
+    if (process.env['GL_TOKEN']) {
+        authToken = process.env['GL_TOKEN']
+    } else if (!(authToken = getEnvOrConfig("GITLAB_TOKEN", "gitlabToken", pluginConfig))) {
+        throw new Error("Gitlab Token not supplied(Env: GL_TOKEN/GITLAB_TOKEN, config: gitlabToken)")
+    }
+
+    let axiosOptions = {
+        url: apiUrl + (url.startsWith("/") ? "" : "/") + url,
+        method: method,
+        validateStatus: () => true,
+        ...options
+    }
+
+    if(!axiosOptions.headers) {
+        axiosOptions.headers = {}
+    }
+
+    axiosOptions.headers["PRIVATE-TOKEN"] = authToken
+
+
+
+    return await axios(axiosOptions)
+}
+
+module.exports = {
+    gitlabRequest
+}

package/lib/success.js

@@ -0,0 +1,54 @@
+const {generateAdditionalTags} = require("./tags")
+const {getEnvOrConfigOrDefault, getEnvOrConfig} = require("./util")
+const {gitlabRequest} = require("./gitlab")
+
+
+module.exports = async (pluginConfig, { nextRelease: { version }, logger, options: { repositoryUrl } }) => {
+    let additionalTags = generateAdditionalTags(pluginConfig, version)
+
+    logger.log("Adding additional tags", additionalTags)
+
+    if (getEnvOrConfigOrDefault("ADDITIONAL_TAGS_GITLAB", "useGitlabApi", pluginConfig, false)) {
+        const commitSha = getEnvOrConfig("CI_COMMIT_SHA", "commitSha", pluginConfig)
+        logger.log(`Using gitlab api to add tags to commit ${commitSha}`)
+        const projectID = encodeURI(getEnvOrConfig('CI_PROJECT_ID', 'projectPath', pluginConfig))
+
+        for (let additionalTag of additionalTags) {
+            logger.log(`Processing tag ${additionalTag}`)
+            const tagInfo = await gitlabRequest(pluginConfig, 'get', `/projects/${projectID}/repository/tags/${additionalTag}`)
+
+            if (tagInfo.status == 200) {
+                if (tagInfo.data.target == commitSha) {
+                    logger.log("Tag set to right commit, doing nothing")
+                    continue
+                }
+                logger.log(`Deleting old tag ${additionalTag} => ${tagInfo.data.target}`)
+                const deleteResponse = await gitlabRequest(pluginConfig, 'delete', `/projects/${projectID}/repository/tags/${additionalTag}`)
+                if (deleteResponse.status != 204) {
+                    throw new Error(`Failed to delete existing tag ${deleteResponse.status}, ${deleteResponse.data}`)
+                }
+            }
+            logger.log("Adding new tag")
+
+            const addTagResponse = await gitlabRequest(pluginConfig, 'post', `/projects/${projectID}/repository/tags`, {
+                data: {
+                    tag_name: additionalTag,
+                    ref: commitSha
+                }
+            })
+
+            if (addTagResponse.status != 201) {
+                throw new Error(`Failed to create new tag ${additionalTag}, ${addTagResponse.status}, ${addTagResponse.data}`)
+            }
+
+            logger.log(`Tag published: ${additionalTag}`)
+        }
+    } else {
+        logger.log("Using git cli implementation")
+
+        for (let additionalTag of additionalTags) {
+            execSync(`git tag --force ${additionalTag}`)
+        }
+        execSync(`git push ${repositoryUrl} --force --tags`)
+    }
+}

package/lib/tags.js

@@ -0,0 +1,17 @@
+const {getConfigOrDefault} = require("./util")
+const generateAdditionalTags = (pluginConfig, version) => {
+    const [major, minor, patch] = version.split('.')
+
+    const additionalTags = getConfigOrDefault("additionalTags", pluginConfig, [])
+
+    return additionalTags.map(additionalTag =>
+        additionalTag
+            .replace("${major}", major)
+            .replace("${minor}", minor)
+            .replace("${patch}", patch)
+    )
+}
+
+module.exports = {
+    generateAdditionalTags
+}

package/lib/util.js

@@ -0,0 +1,74 @@
+/**
+ * Get the value from env oder plugin config. Env has the higher priority. If both dont exist, throws error
+ *
+ * @param envName environment variable name
+ * @param configName config field name
+ * @param pluginConfig the plugin config
+ * @returns Returns a matching value if it exists, order: env -> config -> error
+ */
+const getEnvOrConfig = (envName, configName, pluginConfig) => {
+    if (process.env[envName]) {
+        return process.env[envName]
+    }
+
+    if (pluginConfig[configName]) {
+        return pluginConfig[configName]
+    }
+
+    throw new Error(`No value found in env(${envName}) or pluginConfig(${configName})`)
+}
+
+/**
+ * Get the value from env oder plugin config. Env has the higher priority. If both dont exist, returns defaultValue
+ *
+ * @param envName environment variable name
+ * @param configName config field name
+ * @param pluginConfig the plugin config
+ * @param defaultValue fallback value
+ * @returns Returns the env var, config value or fallback defaultValue
+ */
+const getEnvOrConfigOrDefault = (envName, configName, pluginConfig, defaultValue) => {
+    try {
+        return getEnvOrConfig(envName, configName, pluginConfig)
+    } catch (err) {
+        return defaultValue
+    }
+}
+
+/**
+ * Get the value from the plugin config, or the default value if the config does not contain the key
+ *
+ * @param configName
+ * @param pluginConfig
+ * @param defaultValue
+ * @returns {*}
+ */
+const getConfigOrDefault = (configName, pluginConfig, defaultValue) => {
+    if (Object.keys(pluginConfig).includes(configName)) {
+        return pluginConfig[configName]
+    }
+    return defaultValue
+}
+
+/**
+ * Unpacks nested field with specific path
+ *
+ * @param object the source Object
+ * @param path the total path joined with '.' ex. fielda.fieldb.fieldd
+ * @returns {*} the nest
+ */
+const unwrapObject = (object, path) => {
+    for ( let field of path.split(".")) {
+        if (object[field]) {
+            object = object[field]
+        }
+    }
+    return object
+}
+
+module.exports = {
+    getEnvOrConfig,
+    getEnvOrConfigOrDefault,
+    getConfigOrDefault,
+    unwrapObject
+}

package/lib/verify.js

@@ -0,0 +1,44 @@
+const {getEnvOrConfigOrDefault, getEnvOrConfig, unwrapObject, getConfigOrDefault} = require("./util")
+const {gitlabRequest} = require("./gitlab")
+
+module.exports = async (pluginConfig, { logger }) => {
+    if (getEnvOrConfigOrDefault("ADDITIONAL_TAGS_GITLAB", "useGitlabApi", pluginConfig, false)) {
+        logger.log("Gitlab tagging was enabled, testing gitlab Credentials")
+
+        getEnvOrConfig("CI_COMMIT_SHA", "commitSha", pluginConfig)
+
+        const response = await gitlabRequest(
+            pluginConfig,
+            'get',
+            `projects/${encodeURI(getEnvOrConfig('CI_PROJECT_ID', 'projectPath', pluginConfig))}`
+        )
+
+        if (response.status != 200) {
+            logger.log("Failed to authenticate with gitlab", response.status, response.data)
+        }
+
+        let projectAccess = unwrapObject(response.data, "permissions.project_access.access_level")
+        let groupAccess = unwrapObject(response.data, "permissions.group_access.access_level")
+
+        if ((projectAccess && projectAccess >= 30) || (groupAccess && groupAccess >= 30)) {
+            logger.log("Gitlab authentication successful")
+        } else {
+            throw new Error(`Token does not have the required permissions (projectAccess: ${projectAccess}, groupAccess: ${groupAccess})`)
+        }
+    }
+
+    const additionalTags = getConfigOrDefault("additionalTags", pluginConfig, [])
+    if (!Array.isArray(additionalTags)) {
+        throw new Error("Config field additionalTags should be an array of Strings")
+    }
+
+    for (let additionalTag of additionalTags) {
+        if (typeof additionalTag !== 'string') {
+            throw new Error(`Additional tags should be defined as string, got ${typeof additionalTag} for ${additionalTag}`)
+        }
+    }
+
+    logger.log(`The following additional tags were configured: ${additionalTags.join(", ")}`)
+
+
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "semantic-release-additional-tags",
+  "version": "1.0.0",
+  "description": "A semantic-release plugin, with the ability to add additional tags like v1.latest, latest and support for gitlab protected tags",
+  "main": "index.js",
+  "author": "Kai Fink",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.5"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.6",
+    "@semantic-release/npm": "^11.0.2",
+    "semantic-release": "^22.0.12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/4ch3los/semantic-release-additional-tags.git"
+  },
+  "keywords": [
+    "semantic-release",
+    "major-tags",
+    "additional-tags",
+    "tags"
+  ]
+}