Merge pull request #40 from bradennapier/beta

Release Beta

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+If you have changes that you wish to propose, we are open to PR's!  Fork the repo and open your PR against the `beta` branch and we will review it once it has passed the linting checks.

README.md

@@ -43,7 +43,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: bradennapier/eslint-plus-action@v3.4.0
+    - uses: bradennapier/eslint-plus-action@v3.4.1-beta.2
 ```
 
 ## Features
@@ -77,9 +77,9 @@ You provide configuration properties within your workflow by using the `with` pr
 | issueSummaryType | string | compact | false | Changes the PR comment to be "full" (as shown on actions page) or "compact" |
 | issueSummaryMethod | string | edit | false | When issueSummary is enabled, allows having the bot edit or refresh the comment on each new push, can be 'edit' or 'refresh' |
 | issueSummaryOnlyOnEvent | boolean | false | false | Only provide the issue summary comment if there are warnings or errors present? |
+| annotateWarnings | boolean | true | false | By setting this to "false", only errors will be annotated |
 | reportSuggestions | boolean | true | false | Report suggestions when available within the annotations? |
 | reportIgnoredFiles | boolean | false | false | Report a list of any ignored files? |
-| reportWarnings | boolean | true | false | By setting this to "false", only errors will be annotated |
 | reportWarningsAsErrors | boolean | false | false | Report any eslint warnings as errors? |
 | extensions | array | .js,.jsx,.ts,.tsx | false | An array of extensions to lint |
 | includeGlob | array | \*\*/\* | false | Optional array of globs to include from the changed files list |
@@ -131,7 +131,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: bradennapier/eslint-plus-action@v3.4.0
+    - uses: bradennapier/eslint-plus-action@v3.4.1-beta.2
 ```
 
 ## Examples
@@ -149,7 +149,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: bradennapier/eslint-plus-action@v3.4.0
+    - uses: bradennapier/eslint-plus-action@v3.4.1-beta.2
 ```
 
 ### Environment Variables
@@ -162,7 +162,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: bradennapier/eslint-plus-action@v3.4.0
+    - uses: bradennapier/eslint-plus-action@v3.4.1-beta.2
       env:
         NPM_TOKEN: ${{secrets.NPM_TOKEN}}
 ```
@@ -175,7 +175,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: bradennapier/eslint-plus-action@v3.4.0
+    - uses: bradennapier/eslint-plus-action@v3.4.1-beta.2
       env:
         NPM_TOKEN: ${{secrets.NPM_TOKEN}}
       with: 

action.yml

@@ -2,7 +2,7 @@ name: 'ESLint Plus'
 description: 'Runs ESLint against changed files with customization, issue commenting, and more'
 author: 'Braden R. Napier'
 branding: 
-  icon: 'alert-triangle'
+  icon: 'code'
   color: 'red'
 inputs:
   github-token:

lib/utils/SerializerOctokitPlugin/plugin.js

@@ -9,7 +9,6 @@ const artifacts_1 = require("../../artifacts");
 const utils_1 = require("../../utils");
 const ARTIFACTS = new Set();
 exports.SerializerOctokitPlugin = (octokit, clientOptions) => {
-    console.log('[SerializerOctokitPlugin] | Plugin Called: ', clientOptions);
     const { data } = clientOptions.serializer;
     const match = clientOptions.serializer.routes
         ? routeMatcher_1.requestRouteMatcher(clientOptions.serializer.routes)
@@ -28,8 +27,7 @@ exports.SerializerOctokitPlugin = (octokit, clientOptions) => {
                 if (!serializer) {
                     throw new Error('[SerializerOctokitPlugin] | Attempted to serialize a path that is not handled');
                 }
-                data.state.rulesSummaries = [...data.state.rulesSummaries];
-                const serializeResult = yield serializer.serialize(data, requestOptions);
+                const serializeResult = yield serializer.serialize(Object.assign(Object.assign({}, data), { state: Object.assign(Object.assign({}, data.state), { rulesSummaries: Array.from(data.state.rulesSummaries) }) }), requestOptions);
                 console.log('Serialize Result: ', JSON.stringify(serializeResult, null, 2));
                 artifact.requests.add([requestOptions.url, serializeResult]);
                 return serializeResult.result;
@@ -58,10 +56,10 @@ exports.SerializerOctokitPlugin = (octokit, clientOptions) => {
                                 if (!serializer) {
                                     throw new Error(`[SerializerOctokitPlugin] | Attempted to deserialize a path "${route}" which is not handled`);
                                 }
+                                data.state.rulesSummaries = new Map(data.state.rulesSummaries);
                                 yield serializer.deserialize(data, descriptor, octokit);
                                 yield issues_1.handleIssueComment(octokit, data);
                                 yield artifacts_1.updateIssueState(octokit, data);
-                                console.log('Success!');
                                 yield artifacts_1.deleteArtifactByName(octokit, utils_1.getIssueLintResultsName(data));
                             }
                         }

lib/utils/markdown.js

@@ -49,13 +49,14 @@ function getRuleSummary(summary, data) {
   `;
 }
 function getSortedRuleSummaries(data) {
-    if ([...data.state.rulesSummaries].length === 0) {
+    const summaries = Array.from(data.state.rulesSummaries);
+    if (summaries.length === 0) {
         return '';
     }
     return dedent_1.default `
     ---
     
-    ${[...data.state.rulesSummaries]
+    ${summaries
         .sort(([, a], [, b]) => a.level.localeCompare(b.level))
         .map(([, summary]) => getRuleSummary(summary, data))
         .join('\n\n---\n\n')}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-action",
-  "version": "3.4.0",
+  "version": "3.4.1-beta.2",
   "private": true,
   "description": "TypeScript template action",
   "main": "lib/run.js",

release.config.js

@@ -12,8 +12,6 @@ module.exports = {
         preset: 'conventionalcommits',
       },
     ],
-    // creates CHANGELOG.md
-    '@semantic-release/changelog',
     [
       '@google/semantic-release-replace-plugin',
       {
@@ -40,7 +38,7 @@ module.exports = {
       // commits the changed files to git
       '@semantic-release/git',
       {
-        assets: ['package.json', 'CHANGELOG.md', 'README.md'],
+        assets: ['package.json', 'README.md'],
       },
     ],
     // creates the github release

src/utils/SerializerOctokitPlugin/plugin.ts

@@ -22,8 +22,6 @@ export const SerializerOctokitPlugin = (
   clientOptions: Parameters<OctokitPlugin>[1],
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): { [key: string]: (...args: any[]) => any } => {
-  console.log('[SerializerOctokitPlugin] | Plugin Called: ', clientOptions);
-
   const { data }: { data: ActionData } = clientOptions.serializer;
 
   const match = clientOptions.serializer.routes
@@ -69,14 +67,18 @@ export const SerializerOctokitPlugin = (
             );
           }
 
-          // TODO - should probably serialize a small amount of data and recapture
-          // TODO - this data when needed on scheduler.
-          // we need to convert these for them to be usable
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          (data.state as any).rulesSummaries = [...data.state.rulesSummaries];
-
           const serializeResult = await serializer.serialize(
-            data,
+            {
+              ...data,
+              state: {
+                ...data.state,
+                // TODO - should probably serialize a small amount of data and recapture
+                // TODO - this data when needed on scheduler.
+                // we need to convert these for them to be usable
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                rulesSummaries: Array.from(data.state.rulesSummaries) as any,
+              },
+            },
             requestOptions,
           );
 
@@ -139,12 +141,13 @@ export const SerializerOctokitPlugin = (
                 );
               }
 
+              // this is converted with Array.from() before serializing, turn back into map
+              data.state.rulesSummaries = new Map(data.state.rulesSummaries);
+
               await serializer.deserialize(data, descriptor, octokit);
               await handleIssueComment(octokit, data);
               await updateIssueState(octokit, data);
 
-              console.log('Success!');
-
               // the result artifact can now be removed
               await deleteArtifactByName(
                 octokit,

src/utils/markdown.ts

@@ -75,13 +75,14 @@ function getRuleSummary(summary: LintRuleSummary, data: ActionData): string {
 }
 
 export function getSortedRuleSummaries(data: ActionData): string {
-  if ([...data.state.rulesSummaries].length === 0) {
+  const summaries = Array.from(data.state.rulesSummaries);
+  if (summaries.length === 0) {
     return '';
   }
   return dedent`
     ---
     
-    ${[...data.state.rulesSummaries]
+    ${summaries
       .sort(([, a], [, b]) => a.level.localeCompare(b.level))
       .map(([, summary]) => getRuleSummary(summary, data))
       .join('\n\n---\n\n')}