chore(pr-lint): provide output to user in comments

.github/workflows/pr-linter.yml

@@ -16,7 +16,7 @@ jobs:
   validate-pr:
     permissions:
       contents: read
-      pull-requests: read
+      pull-requests: write
     runs-on: ubuntu-latest
     steps:
 
@@ -29,5 +29,5 @@ jobs:
       - name: Validate
         uses: ./tools/@aws-cdk/prlint
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.PROJEN_GITHUB_TOKEN }}
           REPO_ROOT: ${{ github.workspace }}

CONTRIBUTING.md

@@ -267,10 +267,10 @@ Integration tests perform a few functions in the CDK code base -
 
 The following list contains common scenarios where we _know_ that integration tests are required.
 This is not an exhaustive list and we will, by default, require integration tests for all
-new features unless there is a good reason why one is not needed.
+new features and all fixes unless there is a good reason why one is not needed.
 
-1. Adding a new feature that is using previously unused CloudFormation resource types
-2. Adding a new feature that is using previously unused (or untested) CloudFormation properties
+1. Adding a new feature
+2. Adding a fix to an existing feature
 3. Involves configuring resource types across services (i.e. integrations)
 4. Adding a new supported version (e.g. a new [AuroraMysqlEngineVersion](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds.AuroraMysqlEngineVersion.html))
 5. Adding any functionality via a [Custom Resource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html)

tools/@aws-cdk/prlint/README.md

@@ -9,8 +9,8 @@ A Github action that checks pull requests around PR titles, description and othe
 This check validates that the modified files in the PR follow these rules:
 
 1. `feat` requires a change to a `README.md`.
-2. `feat` requires a change to a test file.
-3. `fix` requires a change to a test file.
+2. `feat` requires a change to a unit test file and integration test files.
+3. `fix` requires a change to a unit test file and integration test files.
 4. `BREAKING CHANGE` section is formatted correctly, per the [conventional commits] spec.
 5. No breaking changes announced for stable modules.
 
@@ -42,22 +42,3 @@ steps:
     env:
       REPO_ROOT: ${{ github.workspace }}
 ```
-
-# Testing locally
-
-To test the linter against an actual PR locally, run
-
-```console
-env REPO_ROOT=/path/to/cdk/repo node lint.js validatePr 5857
-
-Creating un-authenticated GitHub Client
-⌛  Fetching PR number 5857
-⌛  Fetching files for PR number 5857
-⌛  Validating...
-Error: Features must contain a change to a README file
-    at featureContainsReadme (/Users/epolon/dev/src/github.com/aws/aws-cdk/tools/prlint/index.js:43:15)
-    at Object.mandatoryChanges (/Users/epolon/dev/src/github.com/aws/aws-cdk/tools/prlint/index.js:74:5)
-    at process._tickCallback (internal/process/next_tick.js:68:7)
-```
-
-Note that an **un-authenticated** GitHub client is created, unless you set the `GITHUB_TOKEN` env variable.

tools/@aws-cdk/prlint/action.yml

@@ -1,5 +1,5 @@
 name: Pull Request Linter
 description: Execute validation rules on GitHub Pull Requests
 runs:
-  using: node12
-  main: index.js
+  using: node16
+  main: index.js

tools/@aws-cdk/prlint/decs.d.ts

@@ -1,5 +1,3 @@
-declare module 'github-api';
-
 declare module 'conventional-commits-parser' {
   function sync(commitMsg: string): Parsed;
 

tools/@aws-cdk/prlint/index.ts

@@ -3,17 +3,21 @@ import * as github from '@actions/github';
 import * as linter from './lint';
 
 async function run() {
-    const number = github.context.issue.number;
+  const token: string = process.env.GITHUB_TOKEN!;
+  const client = github.getOctokit(token).rest.pulls;
 
-    try {
-
-        await linter.validatePr(number);
-
-    } catch (error) {
-
-        core.setFailed(error.message);
-    }
+  const prLinter = new linter.PullRequestLinter({
+    client,
+    owner: github.context.repo.owner,
+    repo: github.context.repo.repo,
+    number: github.context.issue.number,
+  });
 
+  try {
+    await prLinter.validate()
+  } catch (error) {
+    core.setFailed(error.message);
+  }
 }
 
 run()