Merge pull request #2 from tivv/add_filter

Add filter

Author: tivv

README.md

@@ -27,6 +27,12 @@ Optional. Title for the check run to create. Defaults to `Checkstyle Source Code
 ### `token`
 Optional. GitHub API access token. Defaults to `${{ github.token }}`, which is set by `actions/checkout@v2` minimally.
 
+### `changed-since`
+Optional. This option allow uploading only violations in files that were changed 
+between the current commit and the base commit. Set this parameter to base branch name or commit to 
+skip marking violations on unchanged files. This is especially useful when project code style is changed
+and iterative clean-up is performed.
+
 ## Example usage
 
 ```yaml

action.yml

@@ -22,6 +22,12 @@ inputs:
       Also when generating a new PAT, select the least scopes necessary.
       [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
     default: ${{ github.token }}
+  changed-since:
+    description: >
+      This option allow uploading only violations in files that were changed 
+      between the current commit and the base commit. Set this parameter to base branch name or commit to 
+      skip marking violations on unchanged files. This is especially useful when project code style is changed
+      and iterative clean-up is performed.
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -113,6 +113,7 @@ var Inputs;
     Inputs["Title"] = "title";
     Inputs["Path"] = "path";
     Inputs["Token"] = "token";
+    Inputs["ChangedSince"] = "changed-since";
 })(Inputs = exports.Inputs || (exports.Inputs = {}));
 
 
@@ -184,15 +185,20 @@ function run() {
             const name = core.getInput(constants_1.Inputs.Name);
             const title = core.getInput(constants_1.Inputs.Title);
             const commit = core.getInput(constants_1.Inputs.Commit);
+            const changedSince = core.getInput(constants_1.Inputs.ChangedSince);
+            const filter = yield getFilter(commit, changedSince);
+            core.debug(`Got the filter of ${filter} files, e.g. ${filter.slice(0, 3)}`);
             const searchResult = yield search_1.findResults(path);
             if (searchResult.filesToUpload.length === 0) {
                 core.warning(`No files were found for the provided path: ${path}. No results will be uploaded.`);
             }
             else {
                 core.info(`With the provided path, there will be ${searchResult.filesToUpload.length} results uploaded`);
                 core.debug(`Root artifact directory is ${searchResult.rootDirectory}`);
-                const annotations = ramda_1.chain(annotations_1.annotationsForPath, searchResult.filesToUpload);
-                core.debug(`Grouping ${annotations.length} annotations into chunks of ${MAX_ANNOTATIONS_PER_REQUEST}`);
+                const allAnnotations = ramda_1.chain(annotations_1.annotationsForPath, searchResult.filesToUpload);
+                const annotations = filter.length == 0 ? allAnnotations :
+                    allAnnotations.filter(annotation => filter.includes(annotation.path));
+                core.debug(`Grouping ${annotations.length} filtered out of ${allAnnotations.length} annotations into chunks of ${MAX_ANNOTATIONS_PER_REQUEST}`);
                 const groupedAnnotations = annotations.length > MAX_ANNOTATIONS_PER_REQUEST
                     ? ramda_1.splitEvery(MAX_ANNOTATIONS_PER_REQUEST, annotations)
                     : [annotations];
@@ -225,6 +231,20 @@ function getConclusion(annotations) {
     }
     return 'success';
 }
+function getFilter(commit, changedSince) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (changedSince == "") {
+            return [];
+        }
+        const octokit = github_2.getOctokit(core.getInput(constants_1.Inputs.Token));
+        const head_sha = commit ||
+            (github_2.context.payload.pull_request && github_2.context.payload.pull_request.head.sha) ||
+            github_2.context.sha;
+        const req = Object.assign(Object.assign({}, github_2.context.repo), { head: head_sha, base: changedSince });
+        const compare = yield octokit.repos.compareCommits(req);
+        return compare.data.files.map(file => file.filename);
+    });
+}
 function createCheck(name, commit, title, annotations, processedErrors, numErrors, conclusion) {
     return __awaiter(this, void 0, void 0, function* () {
         const head_sha = commit ||

src/constants.ts

@@ -3,5 +3,6 @@ export enum Inputs {
   Commit = 'commit',
   Title = 'title',
   Path = 'path',
-  Token = 'token'
+  Token = 'token',
+  ChangedSince = 'changed-since'
 }

src/main.ts

@@ -14,7 +14,10 @@ async function run(): Promise<void> {
     const name = core.getInput(Inputs.Name)
     const title = core.getInput(Inputs.Title)
     const commit = core.getInput(Inputs.Commit)
+    const changedSince = core.getInput(Inputs.ChangedSince)
 
+    const filter = await getFilter(commit, changedSince)
+    core.debug(`Got the filter of ${filter} files, e.g. ${filter.slice(0, 3)}`)
     const searchResult = await findResults(path)
     if (searchResult.filesToUpload.length === 0) {
       core.warning(
@@ -26,12 +29,15 @@ async function run(): Promise<void> {
       )
       core.debug(`Root artifact directory is ${searchResult.rootDirectory}`)
 
-      const annotations: Annotation[] = chain(
+      const allAnnotations: Annotation[] = chain(
         annotationsForPath,
         searchResult.filesToUpload
       )
+      const annotations = filter.length == 0 ? allAnnotations :
+        allAnnotations.filter(annotation => filter.includes(annotation.path))
+
       core.debug(
-        `Grouping ${annotations.length} annotations into chunks of ${MAX_ANNOTATIONS_PER_REQUEST}`
+        `Grouping ${annotations.length} filtered out of ${allAnnotations.length} annotations into chunks of ${MAX_ANNOTATIONS_PER_REQUEST}`
       )
 
       const groupedAnnotations: Annotation[][] =
@@ -89,6 +95,29 @@ function getConclusion(
   return 'success'
 }
 
+async function getFilter(
+  commit: string,
+  changedSince: string
+): Promise<string[]> {
+  if (changedSince == "") {
+    return [];
+  }
+
+  const octokit = getOctokit(core.getInput(Inputs.Token))
+
+  const head_sha = commit ||
+      (context.payload.pull_request && context.payload.pull_request.head.sha) ||
+      context.sha;
+
+  const req = {
+    ...context.repo,
+    head: head_sha,
+    base: changedSince
+  }
+  const compare = await octokit.repos.compareCommits(req)
+  return compare.data.files.map(file => file.filename)
+}
+
 async function createCheck(
   name: string,
   commit: string,