@cycjimmy/semantic-release-action 3.2.0 → 3.4.0

package/README.md

@@ -5,7 +5,7 @@
 [![semantic-release][semantic-image]][semantic-url]
 [![npm license][license-image]][license-url]
 
-GitHub Action for [Semantic Release][semantic-url]. 
+GitHub Action for [Semantic Release][semantic-url].
 
 ## Usage
 ### Step1: Set any [Semantic Release Configuration](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration) in your repository.
@@ -45,16 +45,18 @@ then make sure that you configure this in your `package.json` file:
 ### Inputs
 |  Input Parameter  | Required | Description                                                                                                              |
 |:-----------------:|:--------:|--------------------------------------------------------------------------------------------------------------------------|
-| semantic_version  |  false   | Specify specifying version range for semantic-release. [[Details](#semantic_version)]                                    |
+| semantic_version  |  false   | Specify version range for semantic-release. [[Details](#semantic_version)]                                               |
 |     branches      |  false   | The branches on which releases should happen.[[Details](#branches)]<br>Support for **semantic-release above v16**.       |
 |      branch       |  false   | The branch on which releases should happen.[[Details](#branch)]<br>Only support for **semantic-release older than v16**. |
 |   extra_plugins   |  false   | Extra plugins for pre-install. [[Details](#extra_plugins)]                                                               |
 |      dry_run      |  false   | Whether to run semantic release in `dry-run` mode. [[Details](#dry_run)]                                                 |
+|        ci         |  false   | Whether to run semantic release with CI support. [[Details](#ci)]<br>Support for **semantic-release above v16**.         |
 |      extends      |  false   | Use a sharable configuration [[Details](#extends)]                                                                       |
 | working_directory |  false   | Use another working directory for semantic release [[Details](#working_directory)]                                       |
+|     tag_format    |  false   | Specify format of tag (useful for monorepos)                                                                             |
 
 #### semantic_version
-> {Optional Input Parameter} Specify specifying version range for semantic-release.<br>If no version range is specified, latest version will be used by default.
+> {Optional Input Parameter} Specify version range for semantic-release.
 
 ```yaml
 steps:
@@ -63,14 +65,17 @@ steps:
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v3
     with:
-      semantic_version: 15.13.28  # It is recommended to specify specifying version range
-                                  # for semantic-release.
+      semantic_version: 19.0.5  # It is recommended to specify a version range
+                                # for semantic-release when using
+                                # semantic-release-action lower than @v3
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
-*It is recommended to manually specify a version of semantic-release to prevent errors caused during the official semantic-release upgrade.*
+If no version range is specified with `cycjimmy/semantic-release-action@v3` then [semantic-release](https://github.com/semantic-release/semantic-release/) version [19.0.5](https://github.com/semantic-release/semantic-release/releases/tag/v19.0.5) is used. Earlier versions of `cycjimmy/semantic-release-action` default to using the latest version of [semantic-release](https://github.com/semantic-release/semantic-release/), so in this case it is recommended to specify version 19 or lower to avoid compatibility issues.
+
+*Note: [Version 20.0.0](https://github.com/semantic-release/semantic-release/releases/tag/v20.0.0) of [semantic-release](https://github.com/semantic-release/semantic-release/) and later is currently incompatible with `cycjimmy/semantic-release-action`, since it requires Node.js 18. GitHub does not provide this environment yet for [JavaScript actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions).*
 
 #### branches
 > {Optional Input Parameter} The branches on which releases should happen.<br>`branches` supports for **semantic-release above v16**.
@@ -84,18 +89,18 @@ steps:
     with:
       semantic_version: 16
       # you can set branches for semantic-release above v16.
-      branches: |    
+      branches: |
         [
           '+([0-9])?(.{+([0-9]),x}).x',
-          'master', 
-          'next', 
-          'next-major', 
+          'master',
+          'next',
+          'next-major',
           {
-            name: 'beta', 
+            name: 'beta',
             prerelease: true
-          }, 
+          },
           {
-            name: 'alpha', 
+            name: 'alpha',
             prerelease: true
           }
         ]
@@ -104,14 +109,14 @@ steps:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
-`branches` will override the `branches` attribute in your configuration file. If the attribute is not configured on both sides, the default is: 
+`branches` will override the `branches` attribute in your configuration file. If the attribute is not configured on both sides, the default is:
 ```
 [
   '+([0-9])?(.{+([0-9]),x}).x',
-  'master', 
-  'next', 
-  'next-major', 
-  {name: 'beta', prerelease: true}, 
+  'master',
+  'next',
+  'next-major',
+  {name: 'beta', prerelease: true},
   {name: 'alpha', prerelease: true}
 ]
 ```
@@ -139,9 +144,9 @@ steps:
 It will override the `branch` attribute in your configuration file. If the attribute is not configured on both sides, the default is `master`.
 
 #### extra_plugins
-> {Optional Input Parameter} Extra plugins for pre-install. 
+> {Optional Input Parameter} Extra plugins for pre-install.
 
-The action can be used with `extra_plugins` option to specify plugins which are not in the [default list of plugins of semantic release](https://semantic-release.gitbook.io/semantic-release/usage/plugins#default-plugins). When using this option, please make sure that these plugins are also mentioned in your [semantic release config's plugins](https://semantic-release.gitbook.io/semantic-release/usage/configuration#plugins) array. 
+The action can be used with `extra_plugins` option to specify plugins which are not in the [default list of plugins of semantic release](https://semantic-release.gitbook.io/semantic-release/usage/plugins#default-plugins). When using this option, please make sure that these plugins are also mentioned in your [semantic release config's plugins](https://semantic-release.gitbook.io/semantic-release/usage/configuration#plugins) array.
 
 For example, if you want to use `@semantic-release/git` and `@semantic-release/changelog` extra plugins, these must be added to `extra_plugins` in your actions file and `plugins` in your [release config file](https://semantic-release.gitbook.io/semantic-release/usage/configuration#configuration-file) as shown bellow:
 
@@ -155,7 +160,7 @@ steps:
     with:
       # You can specify specifying version range for the extra plugins if you prefer.
       extra_plugins: |
-        @semantic-release/changelog@3.0.0
+        @semantic-release/changelog@6.0.0
         @semantic-release/git
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -189,6 +194,24 @@ steps:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
+#### ci
+> {Optional Input Parameter} Whether to run semantic release with CI support (default true).<br>`ci` supports for **semantic-release above v16**.
+
+```yaml
+steps:
+  - name: Checkout
+    uses: actions/checkout@v3
+  - name: Semantic Release
+    uses: cycjimmy/semantic-release-action@v3
+    with:
+      ci: false
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+`ci` can be used, e.g in combination with `dry_run` when generating the next release version in pull requests, where `semantic_release` would normally block the execution.
+
 #### extends
 The action can be used with `extends` option to extend an existing [sharable configuration](https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations) of semantic-release. Can be used in combination with `extra_plugins`.
 
@@ -226,6 +249,22 @@ steps:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
+#### tag_format
+The default tag format on semantic-release is `v{version}`. You can override that behavior using this option (helpful when you are using monorepos)
+
+```yaml
+steps:
+  - name: Checkout
+    uses: actions/checkout@v3
+  - name: Semantic Release
+    uses: cycjimmy/semantic-release-action@v3
+    with:
+      tag_format: custom-v{version}
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
 ### Outputs
 |     Output Parameter      | Description                                                                                                                       |
 |:-------------------------:|-----------------------------------------------------------------------------------------------------------------------------------|
@@ -253,7 +292,7 @@ steps:
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      
+
   - name: Do something when a new release published
     if: steps.semantic.outputs.new_release_published == 'true'
     run: |

package/action.yml

@@ -20,12 +20,18 @@ inputs:
   dry_run:
     required: false
     description: 'Whether to run semantic release in `dry-run` mode. It will override the dryRun attribute in your configuration file'
+  ci:
+    required: false
+    description: 'Whether to run semantic release with CI support (default: true). It will override the ci attribute in your configuration file'
   extends:
     required: false
     description: 'One or several sharable configurations, https://semantic-release.gitbook.io/semantic-release/usage/configuration#extends'
   working_directory:
     required: false
     description: 'Specify another working directory for semantic release. Default one is provided by github.'
+  tag_format:
+    required: false
+    description: 'The default tag format on semantic-release is v{version}. You can override that behavior using this option.'
 outputs:
   new_release_published:
     description: 'Whether a new release was published'

package/docs/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.4.0](https://github.com/cycjimmy/semantic-release-action/compare/v3.3.0...v3.4.0) (2023-03-15)
+
+
+### Features
+
+* add `ci` input parameter ([b356b18](https://github.com/cycjimmy/semantic-release-action/commit/b356b18b5f474bb4b9fe4bb5801b364ce24aa8f6))
+
+# [3.3.0](https://github.com/cycjimmy/semantic-release-action/compare/v3.2.0...v3.3.0) (2023-03-07)
+
+
+### Features
+
+* support for option tagFormat ([ed38eb0](https://github.com/cycjimmy/semantic-release-action/commit/ed38eb0e9938eefc792510a75ec48d80fead9b21))
+
 # [3.2.0](https://github.com/cycjimmy/semantic-release-action/compare/v3.1.2...v3.2.0) (2022-11-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cycjimmy/semantic-release-action",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "GitHub Action for Semantic Release",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@cycjimmy/awesome-js-funcs": "^4.0.4",
-    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
     "semantic-release": "^19.0.5"
   }

package/src/handleOptions.js

@@ -60,6 +60,25 @@ exports.handleDryRunOption = () => {
   }
 };
 
+/**
+ * Handle Ci Option
+ * @returns {{}|{ci: boolean}}
+ */
+exports.handleCiOption = () => {
+  const ci = core.getInput(inputs.ci);
+
+  switch (ci) {
+    case 'true':
+      return { ci: true, noCi: false };
+
+    case 'false':
+      return { ci: false, noCi: true };
+
+    default:
+      return {};
+  }
+};
+
 /**
  * Handle Extends Option
  * @returns {{}|{extends: Array}|{extends: String}}
@@ -77,3 +96,19 @@ exports.handleExtends = () => {
     return {};
   }
 };
+
+/**
+ * Handle TagFormat Option
+ * @returns {{}|{tagFormat: String}}
+ */
+exports.handleTagFormat = () => {
+  const tagFormat = core.getInput(inputs.tag_format);
+
+  if (tagFormat) {
+    return {
+      tagFormat
+    };
+  } else {
+    return {};
+  }
+};

package/src/index.js

@@ -2,7 +2,9 @@ const core = require('@actions/core');
 const {
   handleBranchesOption,
   handleDryRunOption,
+  handleCiOption,
   handleExtends,
+  handleTagFormat,
 } = require('./handleOptions');
 const setUpJob = require('./setUpJob.task');
 const installSpecifyingVersionSemantic = require('./installSpecifyingVersionSemantic.task');
@@ -28,7 +30,9 @@ const release = async () => {
   const result = await semanticRelease({
     ...handleBranchesOption(),
     ...handleDryRunOption(),
+    ...handleCiOption(),
     ...handleExtends(),
+    ...handleTagFormat()
   });
 
   await cleanupNpmrc();

package/src/inputs.json

@@ -4,6 +4,8 @@
   "branch": "branch",
   "extra_plugins": "extra_plugins",
   "dry_run": "dry_run",
+  "ci": "ci",
   "extends": "extends",
-  "working_directory": "working_directory"
+  "working_directory": "working_directory",
+  "tag_format": "tag_format"
 }