feat(output): print output parameters (#458)

flaxel · web-flow · commit 3e6d35b685f0 · 2021-06-03T09:18:48.000-04:00
* ✨ print output parameters

* 📝 add output table

* ⚗️ try output parameters

* ⚗️ stringify output

* ⚗️ try test output

* 🔥 remove test output

* 💚 build and lint code

* 🔥 remove output test

* 🔒 fix vulnerabilities

* 🎨 renaming staled variables

* 🎨 build code

* 📝 update contributing commands
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -19,7 +19,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: ./
+        id: stale
         with:
           stale-issue-message: 'This issue is stale'
           stale-pr-message: 'This PR is stale'
           debug-only: true
+      - name: print outputs
+        run: echo ${{ join(steps.stale.outputs.*, ',') }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,19 +21,19 @@ $ npm test
 Run the tests and display only the first failing tests :heavy_check_mark:
 
 ```bash
-$ npm test:only-errors
+$ npm run test:only-errors
 ```
 
 Run the tests with the watch mode :heavy_check_mark:
 
 ```bash
-$ npm test:watch
+$ npm run test:watch
 ```
 
 Run the linter and fix (almost) every issue for you :heavy_check_mark:
 
 ```bash
-$ npm lint:all:fix
+$ npm run lint:all:fix
 ```
 
 # Before creating a PR
@@ -43,7 +43,7 @@ $ npm lint:all:fix
 Build, lint, package and test everything.
 
 ```bash
-$ npm all
+$ npm run all
 ```
 
 # Release
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ The default configuration will:
 
 ## All options
 
-### List of options
+### List of input options
 
 Every argument is optional.
 
@@ -61,6 +61,13 @@ Every argument is optional.
 | [exempt-all-pr-assignees](#exempt-all-pr-assignees)                 | Override [exempt-all-assignees](#exempt-all-assignees) for PRs only      |                       |
 | [enable-statistics](#enable-statistics)                             | Display statistics in the logs                                           | `true`                |
 
+### List of output options
+
+| Output            | Description                                  |
+| ----------------- | -------------------------------------------- |
+| staled-issues-prs | List of all staled issues and pull requests. |
+| closed-issues-prs | List of all closed issues and pull requests. |
+
 ### Detailed options
 
 #### repo-token
diff --git a/action.yml b/action.yml
@@ -168,6 +168,11 @@ inputs:
     description: 'Display some statistics at the end regarding the stale workflow (only when the logs are enabled).'
     default: 'true'
     required: false
+outputs:
+  closed-issues-prs:
+    description: 'List of all closed issues and pull requests.'
+  staled-issues-prs:
+    description: 'List of all staled issues and pull requests.'
 runs:
   using: 'node12'
   main: 'dist/index.js'
diff --git a/dist/index.js b/dist/index.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/main.ts b/src/main.ts
@@ -2,12 +2,19 @@ import * as core from '@actions/core';
 import {IssuesProcessor} from './classes/issues-processor';
 import {isValidDate} from './functions/dates/is-valid-date';
 import {IIssuesProcessorOptions} from './interfaces/issues-processor-options';
+import {Issue} from './classes/issue';
 
 async function _run(): Promise<void> {
   try {
     const args = _getAndValidateArgs();
 
-    await new IssuesProcessor(args).processIssues();
+    const issueProcessor: IssuesProcessor = new IssuesProcessor(args);
+    await issueProcessor.processIssues();
+
+    await processOutput(
+      issueProcessor.closedIssues,
+      issueProcessor.staleIssues
+    );
   } catch (error) {
     core.error(error);
     core.setFailed(error.message);
@@ -103,6 +110,14 @@ function _getAndValidateArgs(): IIssuesProcessorOptions {
   return args;
 }
 
+async function processOutput(
+  staledIssues: Issue[],
+  closedIssues: Issue[]
+): Promise<void> {
+  core.setOutput('staled-issues-prs', JSON.stringify(staledIssues));
+  core.setOutput('closed-issues-prs', JSON.stringify(closedIssues));
+}
+
 function _toOptionalBoolean(
   argumentName: Readonly<string>
 ): boolean | undefined {
