feat(semantic-release): support json branches input

open-turo · Sep 29, 2023 · 7d81c16 · 7d81c16
1 parent 2287ead
commit 7d81c16
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 6 deletions.
diff --git a/semantic-release/README.md b/semantic-release/README.md
@@ -36,7 +36,7 @@ jobs:
 
 | parameter | description | required | default |
 | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------- |
-| branches | Override the branches where semantic release runs on  | `false` | |
+| branches | Override the branches where semantic release runs on. Accepts string or JSON object. | `false` | |
 | ci | Set to false to skip Continuous Integration environment verifications | `false` | |
 | dry-run | Whether to run semantic release in `dry-run` mode. It will override the dryRun attribute in your configuration file | `false` | |
 | extra-plugins | Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config. | `false` | @open-turo/semantic-release-config@^1.4.0 |

diff --git a/semantic-release/action.yaml b/semantic-release/action.yaml
@@ -11,7 +11,7 @@ inputs:
  default: ${{ github.token }}
  branches:
  required: false
- description: "Override the branches where semantic release runs on"
+ description: "Override the branches where semantic release runs on. Accepts a string or a JSON object."
  ci:
  required: false
  description: "Set to false to skip Continuous Integration environment verifications"

diff --git a/semantic-release/dist/index.js b/semantic-release/dist/index.js
diff --git a/semantic-release/dist/index.js.map b/semantic-release/dist/index.js.map
diff --git a/semantic-release/src/index.ts b/semantic-release/src/index.ts
@@ -27,7 +27,7 @@ const OUTPUTS = {
 } as const;
 
 interface Inputs {
- branches?: string;
+ branches?: string | JSON;
  ci: boolean;
  dryRun: boolean;
  extraPlugins: string[];
@@ -67,8 +67,16 @@ async function runNpmInstall(packages: string[]) {
  * Get inputs from the environment
  */
 function getInputs(): Inputs {
+ let branches: string | JSON | undefined;
+ try {
+ branches =
+ process.env.SEMANTIC_ACTION_BRANCHES &&
+ (JSON.parse(process.env.SEMANTIC_ACTION_BRANCHES) as JSON);
+ } catch {
+ branches = process.env.SEMANTIC_ACTION_BRANCHES;
+ }
  return {
- branches: process.env.SEMANTIC_ACTION_BRANCHES || undefined,
+ branches: branches || undefined,
  ci: process.env.SEMANTIC_ACTION_CI === "true",
  dryRun: process.env.SEMANTIC_ACTION_DRY_RUN === "true",
  extraPlugins: (process.env.SEMANTIC_ACTION_EXTRA_PLUGINS || "")