actually stale is not allowed

LouisBrunner · Jul 25, 2023 · 0e8a1a8 · 0e8a1a8
1 parent a1e5113
commit 0e8a1a8
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 5 deletions.
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -97,7 +97,7 @@ jobs:
     - uses: ./
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-        name: Test Basic stale
+        name: Test Basic Stale
         conclusion: stale
 
   # With details

diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ _Optional_ The SHA of the target commit. Defaults to the current commit.
 
 ### `conclusion`
 
-_Optional_ (**Required** if `status` is `completed`, the default) The conclusion of your check, can be either `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required`, `skipped` or `stale`
+_Optional_ (**Required** if `status` is `completed`, the default) The conclusion of your check, can be either `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `skipped`
 
 ### `status`
 

diff --git a/dist/index.js b/dist/index.js
diff --git a/src/inputs.ts b/src/inputs.ts
@@ -54,6 +54,9 @@ export const parseInputs = (getInput: GetInput): Inputs.Args => {
   if (conclusion) {
     conclusion = conclusion.toLowerCase() as Inputs.Conclusion;
     if (!Object.values(Inputs.Conclusion).includes(conclusion)) {
+      if (conclusion.toString() === 'stale') {
+        throw new Error(`'stale' is a conclusion reserved for GitHub and cannot be set manually`);
+      }
       throw new Error(`invalid value for 'conclusion': '${conclusion}'`);
     }
   }

diff --git a/src/namespaces/Inputs.ts b/src/namespaces/Inputs.ts
@@ -40,7 +40,6 @@ export enum Conclusion {
   TimedOut = 'timed_out',
   ActionRequired = 'action_required',
   Skipped = 'skipped',
-  Stale = 'stale',
 }
 
 export enum Status {