Update configuration_path input

thehanimo · Sep 10, 2021 · bd02d06 · bd02d06
1 parent 5c9f373
commit bd02d06
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,9 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           pass_on_octokit_error: false
+          configuration_path: ".github/pr-title-checker-config.json"
 ```
 NOTE:
 * `pass_on_octokit_error` is an optional input which defaults to false. Setting it to true will prevent the CI from failing when an octokit error occurs. This is useful when the environment this action is run in is not consistent. For e.g, it could be a missing GITHUB_TOKEN. Thanks to [@bennycode](https://github.com/bennycode) for pointing this out.
+
+* `configuration_path` is also an optional input which defaults to `".github/pr-title-checker-config.json"`. If you wish to store your config file elsewhere, pass in the path here.
diff --git a/action.yml b/action.yml
@@ -10,7 +10,7 @@ inputs:
   pass_on_octokit_error:
     description: "force CI to pass if an octokit error (e.g. missing GITHUB_TOKEN) occurs"
     default: false
-  configuration-path:
+  configuration_path:
     description: "config file path"
     default: ".github/pr-title-checker-config.json"
 runs:

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/index.js b/index.js
@@ -2,7 +2,7 @@ import * as core from "@actions/core";
 import * as github from "@actions/github";
 const [owner, repo] = process.env.GITHUB_REPOSITORY.split("/");
 const issue_number = process.env.GITHUB_REF.split("/")[2];
-const configPath = core.getInput("configuration-path");
+const configPath = process.env.INPUT_CONFIGURATION_PATH;
 const passOnOctokitError = process.env.INPUT_PASS_ON_OCTOKIT_ERROR === "true";
 const { Octokit } = require("@octokit/action");