Merge pull request #13 from vio/add-status

feature: Set total bundle size as a status

.github/workflows/example.yml

@@ -26,3 +26,4 @@ jobs:
       uses: ./
       with:
         webpack-stats-path: examples/app/artifacts/webpack-stats.json
+        repo-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,6 +1,6 @@
 # [BundleStats](https://github.com/relative-ci/bundle-stats) Github Action
 
-This action generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports for webpack stats.
+This action generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports for webpack stats and sets the total bundle size as status description for the commit.
 
 ## Inputs
 
@@ -10,6 +10,11 @@ This action generates [bundle-stats](https://github.com/relative-ci/bundle-stats
 
 [bundle-stats webpack configuration options](https://github.com/relative-ci/bundle-stats/tree/master/packages/cli#webpack-configuration)
 
+### `repo-token`
+
+Github action repo token (eg: `${{ secrets.GITHUB_TOKEN }}`). If provided, the bundle size will be
+added as a status.
+
 ## Outputs
 
 `bundle-stats` artifact with `html` and `json` reports:
@@ -26,4 +31,5 @@ jobs:
       uses: vio/bundle-stats-action@v1
       with:
         webpack-stats-path: 'static/stats.json'
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
 ```

action.yml

@@ -11,3 +11,7 @@ inputs:
     descript: 'Webpack stats filepath'
     required: true
     default: 'dist/webpack-stats.json'
+  repo-token: 
+    description: 'Github action auth token'
+    required: false
+    default: ''

index.js

@@ -1,14 +1,18 @@
 const fs = require('fs').promises;
 const path = require('path');
 const { get } = require('lodash');
+const got = require('got');
 const core = require('@actions/core');
 const artifact = require('@actions/artifact');
 const { createArtifacts } = require('@bundle-stats/cli-utils');
 const { createJobs, createReport } = require('@bundle-stats/utils');
 const { filter, validate } = require('@bundle-stats/utils/lib/webpack');
 
+const { GITHUB_REPOSITORY, GITHUB_SHA } = process.env;
+
 (async () => {
   const statsPath = core.getInput('webpack-stats-path', { required: true });
+  const token = core.getInput('repo-token', { required: false });
 
   try {
     core.debug(`Read webpack stats file from ${statsPath}`);
@@ -59,7 +63,29 @@ const { filter, validate } = require('@bundle-stats/utils/lib/webpack');
     });
 
     const info = get(report, 'insights.webpack.assetsSizeTotal.data.info.displayValue');
-    if (info) {
+
+    if (!info) {
+      core.warning(`Something went wrong, no information available.`);
+      return;
+    }
+
+    if (token) {
+      await got.post(
+        `https://api.github.com/repos/${GITHUB_REPOSITORY}/statuses/${GITHUB_SHA}`,
+        {
+          json: {
+            state: 'success',
+            context: 'bundle-stats',
+            description: info
+          },
+          responseType: 'json',
+          headers: {
+            authorization: `Bearer ${token}`,
+            'content-type': 'application/json'
+          }
+        }
+      );
+    } else {
       core.warning(`Total Bundle Size: ${info}`);
     }
   } catch (error) {