Research GitHub Actions + Code Suggester for linters

[grayside]

Linting is a great way to enforce standards, but the work churn created by linting mistakes is frustrating. Investigate how to use googleapis/code-suggester with GitHub Actions to automatically "suggest" lint fixes to PRs so contributors can accept corrections with a couple clicks.

I consider this a P1 because I want to establish this as a key element of project productivity early.

[grayside]

Example Workflow

This workflow uses the official hashicorp action to working with Terraform in GitHub Action to send terraform fmt corrections.

on:
  pull_request_target:
    types: [opened, synchronize]
    branches:
      - main
name: ci
jobs:
  terraform-fmt:
    runs-on: ubuntu-latest
    env:
      ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v2
        with:
          ref: ${{github.event.pull_request.head.ref}}
          repository: ${{github.event.pull_request.head.repo.full_name}}
      - uses: hashicorp/setup-terraform@v1
      - run: terraform init
      - name: Terraform Fmt
        run: terraform fmt --recursive
      - uses: googleapis/code-suggester@v1 # takes the changes from git directory
        with:
          command: review
          pull_number: ${{ github.event.pull_request.number }}
          git_dir: '.'

When a PR is sent with a "dirty" change, actions creates PR comments like so:

[grayside]

Exit criteria on this issue is:

• Guidelines on creating linter actions, including how to handle access tokens
• Documentation on actions/workflow tools that have been enabled

[dinagraves]

I recommend using black and/or flake8 for Python files.