Skip to content

Latest commit

 

History

History
121 lines (80 loc) · 3.81 KB

README.md

File metadata and controls

121 lines (80 loc) · 3.81 KB
Raw

typescript-action status

Comment on PRs with missing / obtained approvals

GitHub's UI doesn't always make it clear which approvals remain for a PR. This action adds a comment to a PR clearly indicating who is needed to approve the PR based on the files on the PR.

As approvals come in the comment is updated to reflect the current approval status and which files still need approval.

Sample comments

If all files in the PR are approved the action leaves this comment.

Review status

All files in the PR are approved.

Otherwise, the action leaves a comment with up to three sections, depending on the state of the approvals.

Review status

PR can not be approved, as these files can not be approved by the current reviewers:

✗ path/to/file: owner1

Waiting for approval

✗ path/to/another/file: owner2

Approved files

✓ file/with/no/owners: File has no owners, no approval required
✓ approved/file: owner3

In this example there are four files in the PR.

path/to/file can not be approved as the owner of the file is owner1, but they are not a reviewer on the PR.

path/to/another/file can be approved, it is owned by owner2 who is a reviewer on the PR.

The files that need no further approval are listed in a details block to avoid cluttering up the comment with extraneous information.

file/with/no/owners does not need approval as it has no owners.

approved/file needs approval from owner3, who is a reviewer on the PR and has approved it.

Usage

Optional: Create an access token for the action

You must do this if your CODEOWNERS file uses teams, otherwise the action will not be able to expand the team to its list of members.

Follow the instructions at Create a personal access token to create a token that the action can use.

This token must have repo and read:org scopes. The GITHUB_TOKEN secret that GitHub normally provides for actions is insufficient, as it lacks the read:org scope necessary to expand a team to its list of members.

Add the token as an encrypted secret to the repository in which you will be running the action. I use the name CODEOWNERS_ACTION_TOKEN for the secret.

Enable for a repository

Create the directory .github/workflows in the repository if necessary, and then create the file codeowners-report.yml in that directory with the following contents.

name: Codeowners report

on:
  pull_request:
    types: [opened, reopened, synchronize]
  pull_request_review:
    types: [submitted]

jobs:
  codeowners:
    runs-on: ubuntu-latest
    steps:
      - uses: dfinity-lab/codeowners@main
        with:
          codeowners_path: CODEOWNERS
          token: ${{ secrets.CODEOWNERS_ACTION_TOKEN }}

The options you may want to configure are:

  • uses: This will always use the latest version of the code (dfinity-lab/codeowners@main). Adjust this if you want to use a specific release or commit.

  • codeowners_path: Where the CODEOWNERS file is in the repository. Per About code owners valid values are CODEOWNERS, docs/CODEOWNERS, or .github/CODEOWNERS.

  • token: The name of the secret you created in the previous step. If you did not need to create a personal access token you can use secrets.GITHUB_TOKEN as the token value.