@ethima/semantic-release-configuration 2.1.1 → 3.1.0

package/README.md

@@ -7,7 +7,10 @@ configuration supporting a range of languages and platforms supported by the
 ## Features
 
 - Analyzes commits using
-  [`@semantic-release/commit-analyzer`][semantic-release-commit-analyzer-plugin-url].
+  [`@semantic-release/commit-analyzer`][semantic-release-commit-analyzer-plugin-url]
+  and the [`conventional-changelog-conventionalcommits`
+  preset][conventionalcommits-preset-url] implementing the [Conventional
+  Commits specification][conventionalcommits-url].
 - Generates release notes using
   [`@semantic-release/release-notes-generator`][semantic-release-notes-generator-plugin-url].
 - Updates templated content in a project's root-level `README.md` file
@@ -20,8 +23,10 @@ configuration supporting a range of languages and platforms supported by the
 - (Conditionally) maintains NPM package files, i.e. `package.json` and
   publishes using [`@semantic-release/npm`][semantic-release-npm-plugin-url]
   and [`@semantic-release/git`][semantic-release-git-plugin-url].
-- Publishes releases to GitLab using
-  [`@semantic-release/gitlab`][semantic-release-gitlab-plugin-url].
+- Publishes releases to GitHub using
+  [`@semantic-release/github`][semantic-release-github-plugin-url] when
+  running from GitHub Actions and to GitLab using
+  [`@semantic-release/gitlab`][semantic-release-gitlab-plugin-url] otherwise.
 
 ## Usage
 
@@ -36,6 +41,12 @@ configuration supporting a range of languages and platforms supported by the
   [`extends`][semantic-release-extends-configuration-url] configuration for the
   project to be semantically released.
 
+- When using this shareable semantic release configuration from GitHub Actions,
+  ensure a `CI_DEFAULT_BRANCH` environment variable is set to the name of the
+  branch from which releases should be created. Unfortunately, GitHub does not
+  make this information readily available through, for instance, a similarly
+  named environment variable.
+
 ### Configuration
 
 The semantic release configuration has several configuration options itself.
@@ -86,14 +97,9 @@ structure:
 - A `<!-- START_VERSIONED_TEMPLATE` token,
 - the template itself with one or more
   `__NEXT_SEMANTIC_RELEASE_VERSION__` tokens,
-- a comment closing tag `-->
-
-` token,
-- the template itself with one or more
-  `2.1.1` tokens,
-- a comment closing tag `
-
-<!-- END_VERSIONED_TEMPLATE -->`.
+- a comment closing tag `-->`,
+- (optionally) content that was previously templated,
+- a comment closing the templated content `<!-- END_VERSIONED_TEMPLATE -->`.
 
 More concretely a section in a `README` that looks like
 
@@ -103,9 +109,6 @@ More concretely a section in a `README` that looks like
 The next semantically released version will be v__NEXT_SEMANTIC_RELEASE_VERSION__!
 
 -->
-
-The next semantically released version will be v2.1.1!
-
 <!-- END_VERSIONED_TEMPLATE -->
 ```
 
@@ -119,7 +122,7 @@ The next semantically released version will be v__NEXT_SEMANTIC_RELEASE_VERSION_
 
 -->
 
-The next semantically released version will be v2.1.1!
+The next semantically released version will be v1.2.3!
 
 <!-- END_VERSIONED_TEMPLATE -->
 ```
@@ -185,6 +188,8 @@ When this happens, it is typically also necessary to create the initial GitHub
 release by hand from the tag and changelog that was created by the
 [`semantic-release`][semantic-release-url] tooling.
 
+[conventionalcommits-url]: https://www.conventionalcommits.org
+[conventionalcommits-preset-url]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits
 [cosmiconfig-url]: https://www.npmjs.com/package/cosmiconfig
 [gitlab-pat-url]: https://gitlab.com/-/profile/personal_access_tokens
 [npm-token-url]: https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website
@@ -193,6 +198,7 @@ release by hand from the tag and changelog that was created by the
 [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
 [semantic-release-git-plugin-url]: https://github.com/semantic-release/git
+[semantic-release-github-plugin-url]: https://github.com/semantic-release/github
 [semantic-release-gitlab-plugin-url]: https://github.com/semantic-release/gitlab
 [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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethima/semantic-release-configuration",
-  "version": "2.1.1",
+  "version": "3.1.0",
   "description": "A shareable semantic release configuration supporting a range of languages and platforms supported by the Ethima organization.",
   "main": "./src/index.js",
   "repository": {
@@ -21,7 +21,9 @@
     "@google/semantic-release-replace-plugin": "1.2.0",
     "@semantic-release/changelog": "6.0.2",
     "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "8.0.7",
     "@semantic-release/gitlab": "9.5.1",
+    "conventional-changelog-conventionalcommits": "5.0.0",
     "cosmiconfig": "8.0.0"
   }
 }

package/src/index.js

@@ -9,6 +9,8 @@ const GIT_ASSETS = [
   ...CONFIGURATION.files_with_versioned_templates,
 ];
 
+const IS_GITHUB = env.GITHUB_ACTIONS === "true";
+
 // Ensure the NPM plugin gets added to the semantic release pipeline if a
 // `package.json` file is detected
 const NPM_PLUGIN = [];
@@ -21,7 +23,7 @@ try {
 const SEMANTIC_RELEASE_CONFIGURATION = {
   branches: [env.CI_DEFAULT_BRANCH],
   plugins: [
-    "@semantic-release/commit-analyzer",
+    ["@semantic-release/commit-analyzer", { preset: "conventionalcommits" }],
     "@semantic-release/release-notes-generator",
     [
       "@semantic-release/changelog",
@@ -42,7 +44,7 @@ const SEMANTIC_RELEASE_CONFIGURATION = {
           "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}",
       },
     ],
-    "@semantic-release/gitlab",
+    IS_GITHUB ? "@semantic-release/github" : "@semantic-release/gitlab",
   ],
 };