Merge pull request #153 from 1nVitr0/main

feat: add `ci` input parameter

README.md

@@ -50,6 +50,7 @@ then make sure that you configure this in your `package.json` file:
 |      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)                                                                             |
@@ -193,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`.
 

action.yml

@@ -20,6 +20,9 @@ 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'

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}}

src/index.js

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

src/inputs.json

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