@ethima/semantic-release-configuration 4.1.0 → 4.1.2

package/README.md

@@ -15,8 +15,8 @@ configuration supporting a range of languages and platforms supported by the
   [`@semantic-release/release-notes-generator`][semantic-release-notes-generator-plugin-url].
 - Updates templated content in files, e.g. a project's root-level `README.md`,
   with updated version information using
-  [`@google/semantic-release-replace-plugin`][semantic-release-replace-plugin-url]
-  and [`@semantic-release/git`][semantic-release-git-plugin-url].
+  [`semantic-release-replace-plugin`][semantic-release-replace-plugin-url] and
+  [`@semantic-release/git`][semantic-release-git-plugin-url].
 - Maintains a `CHANGELOG.md` from the generated release notes using
   [`@semantic-release/changelog`][semantic-release-changelog-plugin-url] and
   [`@semantic-release/git`][semantic-release-git-plugin-url].
@@ -25,8 +25,8 @@ configuration supporting a range of languages and platforms supported by the
   and [`@semantic-release/git`][semantic-release-git-plugin-url].
 - (Conditionally) maintains Julia package files, i.e. `version` fields in
   `Project.toml` files, using
-  [`@google/semantic-release-replace-plugin`][semantic-release-replace-plugin-url]
-  and [`@semantic-release/git`][semantic-release-git-plugin-url].
+  [`semantic-release-replace-plugin`][semantic-release-replace-plugin-url] and
+  [`@semantic-release/git`][semantic-release-git-plugin-url].
 - Publishes releases to the relevant hosting platform, i.e. GitHub or GitLab,
   using the platform-specific release plugins
   [`@semantic-release/github`][semantic-release-github-plugin-url] or
@@ -314,6 +314,6 @@ release by hand from the tag and changelog that was created by the
 [semantic-release-notes-generator-plugin-url]: https://github.com/semantic-release/release-notes-generator
 [semantic-release-npm-plugin-configuration-url]: https://github.com/semantic-release/npm#npm-registry-authentication
 [semantic-release-npm-plugin-url]: https://www.npmjs.com/package/@semantic-release/npm
-[semantic-release-replace-plugin-url]: https://github.com/google/semantic-release-replace-plugin
+[semantic-release-replace-plugin-url]: https://github.com/jpoehnelt/semantic-release-replace-plugin
 [semantic-release-url]: https://semantic-release.gitbook.io/
 [semantic-versioning-prerelease-precedence-url]: https://semver.org/#spec-item-9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethima/semantic-release-configuration",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "A shareable semantic release configuration supporting a range of languages and platforms supported by the Ethima organization.",
   "main": "./src/index.js",
   "repository": {
@@ -21,13 +21,13 @@
   },
   "homepage": "https://gitlab.com/ethima/semantic-release-configuration#readme",
   "dependencies": {
-    "@google/semantic-release-replace-plugin": "1.2.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/github": "9.0.3",
-    "@semantic-release/gitlab": "12.0.3",
-    "conventional-changelog-conventionalcommits": "6.1.0",
-    "cosmiconfig": "8.2.0"
+    "@semantic-release/github": "9.2.1",
+    "@semantic-release/gitlab": "12.0.6",
+    "conventional-changelog-conventionalcommits": "7.0.2",
+    "cosmiconfig": "8.3.6",
+    "semantic-release-replace-plugin": "1.2.7"
   },
   "devDependencies": {
     "ava": "5.3.1"

package/src/branches.js

@@ -0,0 +1,82 @@
+/**
+ * Determines the type of branch for the provided `branch`, i.e. whether it
+ * represents a "maintenance" or a "prerelease" branch.
+ *
+ * @return object The `branch_prefix` and whether it `is_prerelease`.
+ */
+function determinePrefixedBranchType(
+  branch,
+  { maintenance_branch_prefix, prerelease_branch_prefix },
+) {
+  if (branch.startsWith(maintenance_branch_prefix)) {
+    return { branch_prefix: maintenance_branch_prefix, is_prerelease: false };
+  } else {
+    return { branch_prefix: prerelease_branch_prefix, is_prerelease: true };
+  }
+}
+
+/**
+ * Determines the "branches" for a semantic-release configuration given the
+ * provided `configuration` for the shareable configuration. This ensures more
+ * (patterned) release branches can be supported than would typically be the
+ * case.
+ *
+ * The function is capable of dealing with "primary release branches", the
+ * corresponding "prerelease branch", and patterned "maintenance" and
+ * "prerelease" branches.
+ *
+ * @return array An array containing the determined branch configuration as the
+ * sole entry.
+ */
+function BranchesConfiguration(branch, configuration) {
+  if (configuration.primary_release_branch === branch) {
+    return [branch];
+  }
+
+  if (configuration.prerelease_branch_prefix === branch) {
+    return [
+      configuration.primary_release_branch,
+      { name: branch, prerelease: configuration.prerelease_tag_suffix },
+    ];
+  }
+
+  const { branch_prefix, is_prerelease } = determinePrefixedBranchType(
+    branch,
+    configuration,
+  );
+
+  // The matching pattern is configured to match all allowed permutations of
+  // version specifications as closely as possible to ensure other permutations
+  // that look valid, e.g. `N.z.q`, do not also accidentally match
+  const branch_prefix_separator = configuration.branch_prefix_separator ?? "-";
+  const version_branch_matcher = new RegExp(
+    `^${branch_prefix}${branch_prefix_separator}(?<major>\\d+)(?<minor>\\.(\\d+|x|y))?(\\.(x|z))?$`,
+  );
+  if (version_branch_matcher.test(branch)) {
+    let {
+      groups: { major, minor },
+    } = branch.match(version_branch_matcher);
+
+    // Remove minor parts not representing digits, so they are not included in
+    // the returned `range`
+    const version_part_matcher = new RegExp("\\.\\d+");
+    if (!version_part_matcher.test(minor)) {
+      minor = "";
+    }
+
+    return [
+      configuration.primary_release_branch,
+      {
+        name: branch,
+        ...(is_prerelease
+          ? { prerelease: configuration.prerelease_tag_suffix }
+          : {}),
+        range: `${major}${minor}.x`,
+      },
+    ];
+  }
+
+  return [];
+}
+
+module.exports = BranchesConfiguration;

package/src/index.js

@@ -39,7 +39,7 @@ try {
   accessSync("Project.toml");
   GIT_ASSETS.push("Project.toml");
   JULIA_PROJECT_TOML_PLUGIN.push([
-    "@google/semantic-release-replace-plugin",
+    "semantic-release-replace-plugin",
     {
       replacements: [
         {
@@ -89,7 +89,7 @@ const SEMANTIC_RELEASE_CONFIGURATION = {
       },
     ],
     VersionedTemplatesConfiguration(
-      CONFIGURATION.files_with_versioned_templates
+      CONFIGURATION.files_with_versioned_templates,
     ),
     ...NPM_PLUGIN,
     ...JULIA_PROJECT_TOML_PLUGIN,
@@ -103,7 +103,7 @@ const SEMANTIC_RELEASE_CONFIGURATION = {
     ],
     ...platformSpecificReleasePlugin(
       "GITHUB_ACTIONS",
-      "@semantic-release/github"
+      "@semantic-release/github",
     ),
     ...platformSpecificReleasePlugin("GITLAB_CI", "@semantic-release/gitlab"),
   ],

package/src/versioned-templates.js

@@ -99,14 +99,14 @@ function buildReplacement(
   _, // Index of match start
   _, // Searched text
   filename,
-  context
+  context,
 ) {
   const { next_version_placeholder_token, template_continuation_token } =
     getTemplateTokenConfiguration(filename);
 
   const normalized_template = stripTemplateContinuationTokens(
     template_continuation_token,
-    template
+    template,
   );
 
   return [
@@ -115,7 +115,7 @@ function buildReplacement(
     template_end,
     normalized_template.replaceAll(
       next_version_placeholder_token,
-      context.nextRelease.version
+      context.nextRelease.version,
     ),
     replacement_end,
   ].join("");
@@ -155,7 +155,7 @@ function buildTemplateMatcher(filename) {
       ".*?",
       `(\n[^\n]*${replacement_end_token}[^\n]*?)`,
     ].join(""),
-    "gs"
+    "gs",
   );
 }
 
@@ -190,7 +190,7 @@ function getTemplateTokenConfiguration(filename) {
  */
 function stripTemplateContinuationTokens(
   template_continuation_token,
-  template
+  template,
 ) {
   // The capture group is only necessary when using this matcher in the context
   // of replacement, i.e. where all the matched content should be replaced by
@@ -198,7 +198,7 @@ function stripTemplateContinuationTokens(
   // largest common whitespace prefix for each line in the template
   const indented_continuation_token_matcher = `^(\\s*)${template_continuation_token}`;
   const continuation_prefix_matcher = new RegExp(
-    `${indented_continuation_token_matcher}(?<prefix>\\s*)`
+    `${indented_continuation_token_matcher}(?<prefix>\\s*)`,
   );
 
   const prefix_lengths = template
@@ -213,7 +213,7 @@ function stripTemplateContinuationTokens(
 
   const largest_common_prefix_matcher = new RegExp(
     `${indented_continuation_token_matcher}\\s{${Math.min(...prefix_lengths)}}`,
-    "gm"
+    "gm",
   );
 
   return template.replaceAll(largest_common_prefix_matcher, "$1");
@@ -221,12 +221,12 @@ function stripTemplateContinuationTokens(
 
 /**
  * Returns the semantic release configuration for the
- * `@google/semantic-release-replace-plugin` set up to replace specific tokens
- * with the next semantic release version in the provided {@param files}.
+ * `semantic-release-replace-plugin` set up to replace specific tokens with the
+ * next semantic release version in the provided {@param files}.
  */
 function VersionedTemplatesConfiguration(files) {
   return [
-    "@google/semantic-release-replace-plugin",
+    "semantic-release-replace-plugin",
     {
       replacements: [
         {