feat(repo): add action logic

- create logic for writing annotations from a given json file
- add action.yml
- add example into workflow

[ch8753]

Author: blake-newman

.github/workflows/master-check-publish.yml

@@ -6,14 +6,8 @@ on:
       - master
 
 jobs:
-  healthCheck:
-    strategy:
-      matrix:
-        command:
-          - typecheck
-          - lint
-          - format
-    name: ${{ matrix.command }}
+  healthcheck:
+    name: 'healthcheck'
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v1
@@ -39,9 +33,14 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.ADMIN_GH_TOKEN }}
       - name: 'Install dependencies'
         run: yarn install --frozen-lockfile
-      - run: yarn ${{ matrix.command }}
+      - name: 'Typecheck'
+        run: yarn typecheck
+      - name: 'Lint'
+        run: yarn lint
+      - name: 'Format'
+        run: yarn format
   publish:
-    needs: [healthCheck]
+    needs: [healthcheck]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v1

.github/workflows/pull-request-check.yml

@@ -2,15 +2,8 @@ name: Pull Request Check
 on: [pull_request]
 
 jobs:
-  prCheck:
-    strategy:
-      matrix:
-        command:
-          - typecheck
-          - lint
-          - format
-          - build
-    name: ${{ matrix.command }}
+  healthcheck:
+    name: 'healthcheck'
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v1
@@ -36,4 +29,19 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.ADMIN_GH_TOKEN }}
       - name: 'Install dependencies'
         run: yarn install --frozen-lockfile
-      - run: yarn ${{ matrix.command }}
+      - name: 'Typecheck'
+        run: yarn typecheck
+      - name: 'Lint'
+        run: yarn lint
+      - name: 'Format'
+        run: yarn format
+      - name: 'Build'
+        run: yarn build
+      - name: 'Install dependencies (production)'
+        run: yarn install --frozen-lockfile --production
+      - name: 'Test'
+        uses: ./
+        with:
+          path: ./annotations.json
+          title: Annotation Test
+          token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -20,3 +20,23 @@ Then install with
 ```
 yarn
 ```
+
+## Example workflow
+
+`workflow.yml`
+
+```
+name: workflow
+on: [push]
+jobs:
+  job:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - name: Annotate
+        uses: Attest/annotations-action@v0.1.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          input: './annotations.json'
+          title: 'Annotate Files'
+```

action.yml

@@ -0,0 +1,15 @@
+name: 'Annotations Action'
+description: 'Dynamically label pull requests affecting packages in a monorepo / workspace'
+author: 'Attest Engineering <dev@askattest.com> (https://askattest.com)'
+icon: 'edit-3'
+color: 'blue'
+inputs:
+  secret:
+    description: 'The GITHUB_TOKEN secret'
+  path:
+    description: 'The JSON file to consume'
+  title:
+    description: 'The actions title'
+runs:
+  using: 'node12'
+  main: 'dist/index.js'

annotations.json

@@ -0,0 +1,22 @@
+[
+  {
+    "message": "This is a annotation message",
+    "path": "annotations.json",
+    "column": { "start": 17, "end": 45 },
+    "line": { "start": 3, "end": 3 },
+    "level": "notice"
+  },
+  {
+    "message": "This is a annotation group",
+    "path": "annotations.json",
+    "column": { "start": 3, "end": 4 },
+    "line": { "start": 9, "end": 15 },
+    "level": "notice"
+  },
+  {
+    "message": "This is a annotation on file outside of changed",
+    "path": "LICENSE.md",
+    "line": { "start": 1, "end": 1 },
+    "level": "warning"
+  }
+]

package.json

@@ -46,7 +46,10 @@
     }
   },
   "dependencies": {
-    "@octokit/core": "^2.2.0"
+    "@actions/core": "^1.2.2",
+    "@actions/github": "^2.1.0",
+    "@octokit/core": "^2.2.0",
+    "@octokit/rest": "^16.39.0"
   },
   "devDependencies": {
     "@attest/config-babel-preset-env-node": "^0.1.17",

src/annotation.ts

@@ -0,0 +1,13 @@
+export interface Annotation {
+  message: string
+  path: string
+  line?: AnnotationSourcePositionReference
+  column?: AnnotationSourcePositionReference
+  level: AnnotationLevel
+}
+
+export type AnnotationLevel = 'notice' | 'warning' | 'failure'
+export interface AnnotationSourcePositionReference {
+  start?: number
+  end?: number
+}

src/annotations.ts

@@ -0,0 +1,36 @@
+import { Annotation } from '@/annotation'
+
+export type AnnotationsConclusion = 'success' | 'failure' | 'neutral'
+
+export class Annotations extends Array<Annotation> {
+  public static fromJSON(json: string): Annotations {
+    return new Annotations(...JSON.parse(json))
+  }
+
+  public hasFailure(): boolean {
+    return this.some(annotation => annotation.level === 'failure')
+  }
+
+  public hasWarning(): boolean {
+    return this.some(annotation => annotation.level === 'warning')
+  }
+
+  public get failures(): Annotation[] {
+    return this.filter(annotation => annotation.level === 'failure')
+  }
+
+  public get warnings(): Annotation[] {
+    return this.filter(annotation => annotation.level === 'warning')
+  }
+
+  public get notices(): Annotation[] {
+    return this.filter(annotation => annotation.level === 'notice')
+  }
+
+  public get conclusion(): AnnotationsConclusion {
+    if (this.length === 0) return 'success'
+    if (this.hasFailure()) return 'failure'
+    if (this.hasWarning()) return 'neutral'
+    return 'success'
+  }
+}

src/github.ts

@@ -0,0 +1,90 @@
+import { Annotations } from '@/annotations'
+import { ChecksCreateResponse, ChecksUpdateParamsOutputAnnotations } from '@octokit/rest'
+import { Context } from '@actions/github/lib/context'
+import github from '@actions/github'
+
+export class Github {
+  private readonly client: github.GitHub
+  private readonly context: Context
+  private readonly owner: string
+  private readonly repo: string
+  private readonly sha: string
+  private check: ChecksCreateResponse | null = null
+
+  public constructor(token: string) {
+    this.client = new github.GitHub({
+      auth: token,
+    })
+    this.context = github.context
+    this.owner = this.context.repo.owner
+    this.repo = this.context.repo.repo
+    this.sha = this.context.payload.pull_request?.head.sha ?? this.context.sha
+  }
+
+  private static githubAnnotationFromAnnotation(
+    annotations: Annotations,
+  ): ChecksUpdateParamsOutputAnnotations[] {
+    return annotations.map(annotation => {
+      const { level, message, path, column = {}, line = {} } = annotation
+
+      const startLine = line?.start ?? 0
+      const endLine = line?.end ?? 0
+
+      const isSameLinePosition = startLine === endLine
+      const startColumn = isSameLinePosition ? column?.start ?? line.end : undefined
+      const endColumn = isSameLinePosition ? column?.end ?? line.start : undefined
+
+      return {
+        annotation_level: level,
+        message,
+        path,
+        start_column: startColumn,
+        end_column: endColumn,
+        start_line: startLine,
+        end_line: endLine,
+      }
+    })
+  }
+
+  public async createCheck(name: string): Promise<this> {
+    const { owner, repo, sha } = this
+
+    const response = await this.client.checks.create({
+      owner,
+      repo,
+      name,
+      head_sha: sha,
+      status: 'in_progress',
+    })
+
+    this.check = response.data
+
+    return this
+  }
+
+  public async updateCheckWithAnnotations(annotations: Annotations): Promise<void> {
+    if (this.check === null) return
+
+    const { owner, repo } = this
+    const { name, id } = this.check
+
+    await this.client.checks.update({
+      owner,
+      repo,
+      check_run_id: id,
+      name,
+      status: 'completed',
+      conclusion: annotations.conclusion,
+      output: {
+        title: `${name}: output`,
+        summary: `${annotations.length} annotations written`,
+        text: `
+          - Failures: ${annotations.failures.length}
+          - Warnings: ${annotations.warnings.length}
+          - Notices: ${annotations.notices.length}
+        `,
+        annotations: Github.githubAnnotationFromAnnotation(annotations),
+      },
+    })
+  }
+}

src/index.ts

@@ -0,0 +1,24 @@
+import { Annotations } from '@/annotations'
+import { Github } from '@/github'
+import { getInputs } from '@/inputs'
+import core from '@actions/core'
+import fs from 'fs'
+
+async function main(): Promise<void> {
+  const { token, title, path } = getInputs()
+
+  const github = new Github(token)
+
+  await github.createCheck(title)
+
+  const file = fs.readFileSync(path)
+  const annotations = Annotations.fromJSON(file.toString())
+
+  await github.updateCheckWithAnnotations(annotations)
+}
+
+main().catch(error => {
+  /* eslint-disable-next-line no-console */
+  console.error(error.stack)
+  core.setFailed(`annotations-action: ${error.message}`)
+})