Add more outputs and improve test

Author: Ludovic TOURMAN

.github/workflows/build-test.yaml

@@ -242,10 +242,11 @@ jobs:
           wait-for-completion-timeout: 120s
           display-workflow-run-url-interval: 10s
           display-workflow-run-url-timeout: 120s
-          workflow-logs: print
+          workflow-logs: json-output
           inputs: >-
             {
-              "run-name": "${{ env.RUN_NAME }}"
+              "run-name": "${{ env.RUN_NAME }}",
+              "environment": "${{ matrix.environment }}",
             }
         continue-on-error: true
       - uses: nick-invision/assert-action@v1
@@ -257,9 +258,11 @@ jobs:
           expected: success
           actual: ${{ steps.named-run-workflow.outcome }}
       - uses: nick-invision/assert-action@v1
+        env:
+          EXPECTED_LOG_MESSAGE: "### Env: ${{ matrix.environment }} ###"
         with:
-          expected: "Run name: ${{ env.RUN_NAME }}"
-          actual: ${{ steps.named-run-workflow.outcome }}
+          expected: "true"
+          actual: ${{ fromJson(steps.named-run-workflow.outputs.workflow-logs).echo.*.message == env.EXPECTED_LOG_MESSAGE }}
 
   deploy:
     needs:

.github/workflows/named-run.yml

@@ -8,6 +8,10 @@ on:
         description: 'The distinct run name used to retrieve the run ID. Defaults to the workflow name'
         type: string
         required: false
+      environment:
+        description: 'The environment name'
+        type: string
+        required: true
 
 jobs:
   echo:
@@ -17,4 +21,4 @@ jobs:
         run: sleep 10s
       - name: Echo message
         run: |
-          echo 'Run name: ${{ github.event.inputs.run-name || github.workflow }}'
+          echo '### Env: ${{ github.event.inputs.environment }} ###'

README.md

@@ -86,6 +86,10 @@ For details of the `workflow_dispatch` even see [this blog post introducing this
 
 ## Outputs
 
+### `workflow-id`
+
+> The ID of the worflow run that has been triggered.
+
 ### `workflow-url`
 
 > The URL of the workflow run that has been triggered. It may be undefined if the URL couldn't be retrieved (timeout reached) or if `wait-for-completion` and `display-workflow-run-url` are > both `false`
@@ -95,6 +99,36 @@ For details of the `workflow_dispatch` even see [this blog post introducing this
 > The result of the triggered workflow. May be one of `success`, `failure`, `cancelled`, `timed_out`, `skipped`, `neutral`, `action_required`. The step in your workflow will fail if the triggered workflow completes with `failure`, `cancelled` or `timed_out`. Other workflow conlusion are considered success.
 > Only available if `wait-for-completion` is `true`
 
+### `workflow-logs`
+
+> The logs of the triggered workflow based if `inputs.workflow-logs` is set to either `output`, or `json-output`.  
+> Based on the value, result will be:
+>
+> * `output`: Multiline string
+>
+>   ```log
+>   <job-name> | <datetime> <message>
+>   <job-name> | <datetime> <message>
+>   ...
+>   ```
+>
+> * `json-output`: JSON string
+>
+>   ```json
+>   {
+>     "<job-name>": [
+>       {
+>         "datetime": "<datetime>",
+>         "message": "<message>"
+>       },
+>       {
+>         "datetime": "<datetime>",
+>         "message": "<message>"
+>       }
+>     ]
+>   }
+>   ```
+
 ## Example usage
 
 ### Invoke workflow without inputs. Wait for result
@@ -155,6 +189,32 @@ For details of the `workflow_dispatch` even see [this blog post introducing this
   run: echo "Another Workflow conclusion: ${{ steps.trigger-step.outputs.workflow-conclusion }}"
 ```
 
+### Invoke workflow and scrap output
+
+```yaml
+- name: Invoke workflow and scrap output
+  id: trigger-step
+  uses: aurelien-baudet/workflow-dispatch@v2
+  with:
+    workflow: Another Workflow
+    token: ${{ secrets.PERSONAL_TOKEN }}
+    workflow-logs: json-output
+- name: Another step that can handle the result
+  if: always()
+  run: echo '${{ fromJSON(steps.trigger-step.outputs.workflow-logs).my-remote-job }}'
+```
+
+```yaml
+name: Another Workflow
+
+on:
+  workflow_dispatch:
+
+jobs:
+  my-remote-job:
+    - run: echo "Hello world!"
+```
+
 ### Invoke workflow with a unique run name (since 3.0.0)
 
 ```yaml

action.yaml

@@ -2,10 +2,10 @@ name: 'Workflow Dispatch and wait'
 description: 'Trigger and chain GitHub Actions workflows with workflow_dispatch events and wait for result'
 
 inputs:
-  workflow: 
+  workflow:
     description: 'Name or ID of workflow to run'
     required: true
-  token: 
+  token:
     description: 'GitHub token with repo write access, can NOT use secrets.GITHUB_TOKEN, see readme'
     required: true
   inputs:
@@ -37,18 +37,36 @@ inputs:
     required: false
     default: true
   wait-for-completion-timeout:
-    description: 'Maximum amount of time (+unit) to wait to mark workflow as timed out' 
+    description: 'Maximum amount of time (+unit) to wait to mark workflow as timed out'
     required: false
     default: 1h
   wait-for-completion-interval:
     description: 'Time to wait (+unit) between two polls to get run status'
     required: false
     default: 1m
   workflow-logs:
-    description: 'Indicate what to do with logs of the triggered workflow. `ignore` do not retrieve logs from tiggered workflow. `print` retrieves logs from triggered workflow and print in the workflow that triggered the other workflow.'
+    description: >-
+      Indicate what to do with logs of the triggered workflow.
+      `ignore` do not retrieve logs from tiggered workflow.
+      `print` retrieves logs from triggered workflow and print in the workflow that triggered the other workflow.
+      `output` retrieves logs from triggered workflow and set them as `workflow-logs` output.
+      `json-output` retrieves logs from triggered workflow and return a json array groupped by job name.
     required: false
     default: ignore
 
+outputs:
+  workflow-conclusion:
+    description: 'Conclusion of the triggered workflow'
+  workflow-id:
+    description: 'ID of the triggered workflow'
+  workflow-url:
+    description: 'URL of the triggered workflow'
+  workflow-logs:
+    description: |
+      Logs of the triggered workflow. Based on `inputs.workflow-logs`, format is set to:
+        - `output`: Multiline logs formatted as: '<job-name> | <datetime> <message>'
+        - `json-output`: JSON logs formatted as: '{"<job-name>": [{"<datetime>": "<message>"}]'
+
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -9768,7 +9768,7 @@ function handleLogs(args, workflowHandler) {
             yield (0, workflow_logs_handler_1.handleWorkflowLogsPerJob)(args, workflowRunId);
         }
         catch (e) {
-            core.error(`Failed to handle logs of tirggered workflow. Cause: ${e}`);
+            core.error(`Failed to handle logs of triggered workflow. Cause: ${e}`);
         }
     });
 }
@@ -9794,6 +9794,7 @@ function run() {
             core.info(`Waiting for workflow completion`);
             const { result, start } = yield waitForCompletionOrTimeout(workflowHandler, args.checkStatusInterval, args.waitForCompletionTimeout);
             yield handleLogs(args, workflowHandler);
+            core.setOutput('workflow-id', result === null || result === void 0 ? void 0 : result.id);
             core.setOutput('workflow-url', result === null || result === void 0 ? void 0 : result.url);
             computeConclusion(start, args.waitForCompletionTimeout, result);
         }
@@ -10053,6 +10054,7 @@ class WorkflowHandler {
                 });
                 (0, debug_1.debug)('Workflow Run status', response);
                 return {
+                    id: runId,
                     url: response.data.html_url,
                     status: ofStatus(response.data.status),
                     conclusion: ofConclusion(response.data.conclusion)
@@ -10075,6 +10077,7 @@ class WorkflowHandler {
                 });
                 (0, debug_1.debug)('Workflow Run artifacts', response);
                 return {
+                    id: runId,
                     url: response.data.html_url,
                     status: ofStatus(response.data.status),
                     conclusion: ofConclusion(response.data.conclusion)
@@ -10098,7 +10101,6 @@ class WorkflowHandler {
                     repo: this.repo,
                     workflow_id: workflowId,
                     event: 'workflow_dispatch',
-                    branch: this.ref,
                     created: `>=${new Date(this.triggerDate).toISOString()}`
                 });
                 (0, debug_1.debug)('List Workflow Runs', response);
@@ -10243,6 +10245,16 @@ function handleWorkflowLogsPerJob(args, workflowRunId) {
                 yield handler.handleError(job, error);
             }
         }
+        switch (mode) {
+            case 'json-output':
+                core.setOutput('workflow-logs', handler.getJsonLogs());
+                break;
+            case 'output':
+                core.setOutput('workflow-logs', handler.getRawLogs());
+                break;
+            default:
+                break;
+        }
     });
 }
 exports.handleWorkflowLogsPerJob = handleWorkflowLogsPerJob;
@@ -10265,10 +10277,63 @@ class PrintLogsHandler {
         });
     }
 }
+class OutputLogsHandler {
+    constructor() {
+        this.logs = new Map();
+    }
+    handleJobList(jobs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, debug_1.debug)('Retrieving logs for jobs in workflow', jobs);
+        });
+    }
+    handleJobLogs(job, logs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logs.set(job.name, logs);
+        });
+    }
+    handleError(job, error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            core.warning(escapeImportedLogs(error.message));
+        });
+    }
+    getJsonLogs() {
+        const result = {};
+        const logPattern = /(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{7}Z)\s+(.*)/;
+        this.logs.forEach((logs, jobName) => {
+            result[jobName] = [];
+            for (const line of logs.split('\n')) {
+                if (line === '') {
+                    continue;
+                }
+                const splitted = line.split(logPattern);
+                result[jobName].push({
+                    datetime: splitted[1],
+                    message: splitted[2]
+                });
+            }
+            // result[jobName] = logs;
+        });
+        return JSON.stringify(result);
+    }
+    getRawLogs() {
+        let result = '';
+        this.logs.forEach((logs, jobName) => {
+            for (const line of logs.split('\n')) {
+                result += `${jobName} | ${line}\n`;
+            }
+        });
+        return result;
+    }
+}
 function logHandlerFactory(mode) {
     switch (mode) {
-        case 'print': return new PrintLogsHandler();
-        default: return null;
+        case 'print':
+            return new PrintLogsHandler();
+        case 'output':
+        case 'json-output':
+            return new OutputLogsHandler();
+        default:
+            return null;
     }
 }
 function escapeImportedLogs(str) {

src/main.ts

@@ -97,6 +97,7 @@ async function run(): Promise<void> {
 
     await handleLogs(args, workflowHandler);
 
+    core.setOutput('workflow-id', result?.id);
     core.setOutput('workflow-url', result?.url);
     computeConclusion(start, args.waitForCompletionTimeout, result);
 

src/workflow-handler.ts

@@ -36,6 +36,7 @@ const ofConclusion = (conclusion: string | null): WorkflowRunConclusion => {
 }
 
 export interface WorkflowRunResult {
+  id: number,
   url: string,
   status: WorkflowRunStatus,
   conclusion: WorkflowRunConclusion
@@ -87,6 +88,7 @@ export class WorkflowHandler {
       debug('Workflow Run status', response);
 
       return {
+        id: runId,
         url: response.data.html_url,
         status: ofStatus(response.data.status),
         conclusion: ofConclusion(response.data.conclusion)
@@ -110,6 +112,7 @@ export class WorkflowHandler {
       debug('Workflow Run artifacts', response);
 
       return {
+        id: runId,
         url: response.data.html_url,
         status: ofStatus(response.data.status),
         conclusion: ofConclusion(response.data.conclusion)