@ethima/semantic-release-configuration 4.0.0 → 4.0.1

package/README.md

@@ -35,9 +35,12 @@ configuration supporting a range of languages and platforms supported by the
 
 ## Usage
 
-- Create the relevant secret token for the platform on which the project
-  using this configuration is hosted, e.g. `GH_TOKEN`, `GITLAB_TOKEN`. The
-  supported platforms are [GitHub][semantic-release-github-plugin-auth-url] and
+- Create the [relevant authentication
+  token][semantic-release-authentication-url] for the platform on which the
+  project using this configuration is hosted. This secret will be used by the
+  main `semantic-release` tool for pushing tags as well as the
+  platform-specific plugin i.e.
+  [GitHub][semantic-release-github-plugin-auth-url] or
   [GitLab][semantic-release-gitlab-plugin-auth-url].
 
   For improved security, _use a unique token for every project this
@@ -228,6 +231,7 @@ release by hand from the tag and changelog that was created by the
 [juliahub-register-package-url]: https://juliahub.com/ui/Registrator
 [npm-token-url]: https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website
 [replace-in-file-url]: https://www.npmjs.com/package/replace-in-file
+[semantic-release-authentication-url]: https://semantic-release.gitbook.io/semantic-release/usage/ci-configuration#authentication
 [semantic-release-changelog-plugin-url]: https://github.com/semantic-release/changelog
 [semantic-release-commit-analyzer-plugin-url]: https://github.com/semantic-release/commit-analyzer
 [semantic-release-extends-configuration-url]: https://semantic-release.gitbook.io/semantic-release/usage/configuration#extends

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethima/semantic-release-configuration",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "A shareable semantic release configuration supporting a range of languages and platforms supported by the Ethima organization.",
   "main": "./src/index.js",
   "repository": {
@@ -21,9 +21,9 @@
     "@google/semantic-release-replace-plugin": "1.2.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/github": "8.0.7",
-    "@semantic-release/gitlab": "12.0.1",
-    "conventional-changelog-conventionalcommits": "5.0.0",
-    "cosmiconfig": "8.1.3"
+    "@semantic-release/github": "9.0.3",
+    "@semantic-release/gitlab": "12.0.3",
+    "conventional-changelog-conventionalcommits": "6.0.0",
+    "cosmiconfig": "8.2.0"
   }
 }

package/src/index.js

@@ -9,25 +9,19 @@ const GIT_ASSETS = [
   ...CONFIGURATION.files_with_versioned_templates,
 ];
 
-// Used to detect whether configuration for either the
-// `semantic-release/github`, `semantic-release/gitlab` or both platform
-// release plugins has been provided through the environment
-const GITHUB_TOKEN_NAMES = ["GH_TOKEN", "GITHUB_TOKEN"];
-const GITLAB_TOKEN_NAMES = ["GL_TOKEN", "GITLAB_TOKEN"];
-
 /*
  * Determines whether the provided plugin should be added to the semantic
  * release configuration based on the presence of select environment variables.
  *
- * @param {Array} token_names An array of strings specifying the names of the
- * environment variables to detect.
+ * @param {string} environment_variable The environment variable to verify the
+ * existence of (and equality to `"true"`) to include the specified `plugin`.
  * @param {string} plugin The name of the NPM package providing the plugin.
  *
- * @return {Array} References the plugin if any of the `token_names` are
- * detected and is empty otherwise.
+ * @return {Array} References the plugin if the `environment_variable` was set
+ * to `"true"` and is empty otherwise.
  */
-function platformSpecificReleasePlugin(token_names, plugin) {
-  return token_names.some((token_name) => env[token_name]) ? [plugin] : [];
+function platformSpecificReleasePlugin(environment_variable, plugin) {
+  return env[environment_variable] === "true" ? [plugin] : [];
 }
 
 // Ensure the NPM plugin gets added to the semantic release pipeline if a
@@ -101,13 +95,10 @@ const SEMANTIC_RELEASE_CONFIGURATION = {
       },
     ],
     ...platformSpecificReleasePlugin(
-      GITHUB_TOKEN_NAMES,
+      "GITHUB_ACTIONS",
       "@semantic-release/github"
     ),
-    ...platformSpecificReleasePlugin(
-      GITLAB_TOKEN_NAMES,
-      "@semantic-release/gitlab"
-    ),
+    ...platformSpecificReleasePlugin("GITLAB_CI", "@semantic-release/gitlab"),
   ],
 };