Merge branch 'master' into update-2022

Author: benc-uk

.github/workflows/test.yaml

@@ -0,0 +1,15 @@
+name: Workflow Tester
+
+on: 
+  workflow_dispatch:
+
+jobs:
+  testAction:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Invoke echo 1 workflow using this action
+      uses: ./
+      with:
+        workflow: echo-1.yaml
+        inputs: '{"message": "blah blah this is a test"}'   

.github/workflows/test.yml

@@ -13,13 +13,11 @@ For details of the `workflow_dispatch` even see [this blog post introducing this
 
 ## Inputs
 ### `workflow`
-**Required.** The name or ID of the workflow to trigger and run. This is the name declared in the YAML, not the filename
+**Required.** The name, filename or ID of the workflow to be triggered and run. All three possibilities are checked when looking for the workflow
 
 ### `token`
 
-**Required.** A GitHub access token (PAT) with write access to the repo in question. **NOTE.** The automatically provided token e.g. `${{ secrets.GITHUB_TOKEN }}` can not be used, GitHub prevents this token from being able to fire the  `workflow_dispatch` and `repository_dispatch` event. [The reasons are explained in the docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).  
-
-The solution is to manually create a PAT and store it as a secret e.g. `${{ secrets.PERSONAL_TOKEN }}`
+**Optional.** By default the standard `github.token` will be used and you no longer need to provide a token here. It is left for backwards compatibility only, or in the rare case you want to provide your own token.
 
 ### `inputs`
 **Optional.** The inputs to pass to the workflow (if any are configured), this must be a JSON encoded string, e.g. `{ "myInput": "foobar" }`
@@ -41,15 +39,13 @@ None
   uses: benc-uk/workflow-dispatch@v1
   with:
     workflow: My Workflow
-    token: ${{ secrets.PERSONAL_TOKEN }}
 ```
 
 ```yaml
 - name: Invoke workflow with inputs
   uses: benc-uk/workflow-dispatch@v1
   with:
     workflow: Another Workflow
-    token: ${{ secrets.PERSONAL_TOKEN }}
     inputs: '{ "message": "blah blah", "debug": true }'
 ```
 
@@ -59,6 +55,5 @@ None
   with:
     workflow: Some Workflow
     repo: benc-uk/example
-    token: ${{ secrets.PERSONAL_TOKEN }}
     inputs: '{ "message": "blah blah", "debug": true }'
 ```

README.md

@@ -7,7 +7,8 @@ inputs:
     required: true
   token:
     description: 'GitHub token with repo write access, can NOT use secrets.GITHUB_TOKEN, see readme'
-    required: true
+    required: false
+    default: ${{ github.token }}
   inputs:
     description: 'Inputs to pass to the workflow, must be a JSON string'
     required: false

action.yaml

@@ -558,11 +558,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(__webpack_require__(470));
 const github = __importStar(__webpack_require__(469));
+const PackageJSON = __importStar(__webpack_require__(731));
 //
 // Main task function (async wrapper)
 //
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
+        core.info(`!!!!Workflow Dispatch Action v${PackageJSON.version}`);
         try {
             // Required inputs
             const token = core.getInput('token');
@@ -587,18 +589,21 @@ function run() {
             core.debug('### START List Workflows response data');
             core.debug(JSON.stringify(workflows, null, 3));
             core.debug('### END:  List Workflows response data');
-            // Locate workflow either by name or id
-            const workflowFind = workflows.find((workflow) => workflow.name === workflowRef || workflow.id.toString() === workflowRef);
-            if (!workflowFind)
+            // Locate workflow either by name, id or filename
+            const foundWorkflow = workflows.find((workflow) => {
+                return workflow.name === workflowRef ||
+                    workflow.id.toString() === workflowRef ||
+                    workflow.path.endsWith(workflowRef);
+            });
+            if (!foundWorkflow)
                 throw new Error(`Unable to find workflow '${workflowRef}' in ${owner}/${repo} 😥`);
-            console.log(`!!!Workflow id is: ${workflowFind.id}`);
+            console.log(`Workflow id is: ${foundWorkflow.id}`);
             // Call workflow_dispatch API
-            const dispatchResp = yield octokit.request(`POST /repos/${owner}/${repo}/actions/workflows/${workflowFind.id}/dispatches`, {
+            const dispatchResp = yield octokit.request(`POST /repos/${owner}/${repo}/actions/workflows/${foundWorkflow.id}/dispatches`, {
                 ref: ref,
                 inputs: inputs
             });
-            core.info(`!!!Workflow Dispatch response: ${JSON.stringify(dispatchResp.data)}`);
-            core.info(`!!!API response status: ${dispatchResp.status} 🚀`);
+            core.info(`API response status: ${dispatchResp.status} 🚀`);
         }
         catch (error) {
             const e = error;
@@ -6192,6 +6197,13 @@ exports.default = _default;
 
 /***/ }),
 
+/***/ 731:
+/***/ (function(module) {
+
+module.exports = {"name":"workflow-dispatch","version":"1.2.0","description":"Trigger running GitHub Actions workflows","main":"dist/index.js","scripts":{"build":"ncc build src/main.ts -o dist","lint":"eslint src/"},"keywords":["github","actions"],"author":"Ben Coleman","license":"MIT","devDependencies":{"@actions/core":"^1.10.0","@actions/github":"^5.1.1","@zeit/ncc":"^0.22.3","@typescript-eslint/eslint-plugin":"^5.41.0","@typescript-eslint/parser":"^5.41.0","eslint":"^8.26.0","typescript":"^4.8.4"}};
+
+/***/ }),
+
 /***/ 733:
 /***/ (function(__unusedmodule, exports, __webpack_require__) {
 

dist/index.js

@@ -7,16 +7,19 @@
 
 import * as core from '@actions/core'
 import * as github from '@actions/github'
+import * as PackageJSON from '../package.json'
 
 type Workflow = {
   id: number
   name: string
+  path: string
 }
 
 //
 // Main task function (async wrapper)
 //
 async function run(): Promise<void> {
+  core.info(`!!!!Workflow Dispatch Action v${PackageJSON.version}`)
   try {
     // Required inputs
     const token = core.getInput('token')
@@ -39,26 +42,32 @@ async function run(): Promise<void> {
     octokit.graphql
 
     // List workflows via API, and handle paginated results
-    const workflows: Workflow[] =
-      await octokit.paginate(octokit.rest.actions.listRepoWorkflows.endpoint.merge({ owner, repo, ref, inputs }))
+    const workflows: Workflow[] = await octokit.paginate(
+      octokit.rest.actions.listRepoWorkflows.endpoint.merge({ owner, repo, ref, inputs })
+    )
 
     // Debug response if ACTIONS_STEP_DEBUG is enabled
     core.debug('### START List Workflows response data')
     core.debug(JSON.stringify(workflows, null, 3))
     core.debug('### END:  List Workflows response data')
 
-    // Locate workflow either by name or id
-    const workflowFind = workflows.find((workflow) => workflow.name === workflowRef || workflow.id.toString() === workflowRef)
-    if(!workflowFind) throw new Error(`Unable to find workflow '${workflowRef}' in ${owner}/${repo} 😥`)
-    console.log(`Workflow id is: ${workflowFind.id}`)
+    // Locate workflow either by name, id or filename
+    const foundWorkflow = workflows.find((workflow) => {
+      return workflow.name === workflowRef ||
+        workflow.id.toString() === workflowRef ||
+        workflow.path.endsWith(workflowRef)
+    })
+
+    if(!foundWorkflow) throw new Error(`Unable to find workflow '${workflowRef}' in ${owner}/${repo} 😥`)
+
+    console.log(`Workflow id is: ${foundWorkflow.id}`)
 
     // Call workflow_dispatch API
-    const dispatchResp = await octokit.request(`POST /repos/${owner}/${repo}/actions/workflows/${workflowFind.id}/dispatches`, {
+    const dispatchResp = await octokit.request(`POST /repos/${owner}/${repo}/actions/workflows/${foundWorkflow.id}/dispatches`, {
       ref: ref,
       inputs: inputs
     })
 
-
     core.info(`API response status: ${dispatchResp.status} 🚀`)
   } catch (error) {
     const e = error as Error

src/main.ts

@@ -2,10 +2,11 @@
   "compilerOptions": {
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "rootDir": "./",                          /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     "strict": true,                           /* Enable all strict type-checking options. */
     "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "resolveJsonModule": true
   },
   "exclude": ["node_modules", "**/*.test.ts"]
 }