PR Size Helper action

This action adds size labels to pull requests. If a pull requests is above 1000 lines of additions and deletions, the action will prompt the PR author for more context to help explain the size of the PR. If the author chooses to give additional context, the reason will be tracked along with all others in a digest issue.

The end goal is to proactively capture reasons why pull requests are above 1000 lines of additions + deletions and to index all of those reasons in one easy to find place.

Demo

1. A contributor creates a new PR:

2. pr-size-helper-action labels it with a (configurable) size/ label:

3. If the PR crosses a (configurable) change size threshold the PR creator is prompted to provide more context:

4. When a !reason comment is provided, pr-size-helper-action captures the comment in a digest issue (with configurable destination):

5. The comment is added to the digest issue along with all other !reason comments:

Usage

Create two workflow files:

.github/workflows/apply-pr-size-label.yml

name: Apply PR size label

on: pull_request

jobs:
  apply_pr_size_label:
    runs-on: ubuntu-latest
    steps:
      - uses: levindixon/pr-size-helper-action@v1.5.0
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/track-large-pr-reasons.yml

name: Track large PR reasons

on: issue_comment

jobs:
  track_large_pr_reasons:
    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '!reason') }}
    runs-on: ubuntu-latest
    steps:
      - uses: levindixon/pr-size-helper-action@v1.5.0
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

Configuration

The following environment variables are supported:

• IGNORED: A list of glob expressions separated by newlines. Files matching these expressions will not count when calculating the change size of the pull request. Lines starting with # are ignored and files matching lines starting with ! are always included.
• PROMPT_THRESHOLD: Pull requests created with a combined additions/deletions greater or equal to this value will trigger a friendly message prompting the pull request author to provide a reason for the size of the pull request. Defaults to 500.
• S | M | L | XL | XXL: Setting one, some, or all of these will change the pull request size labelling. Pull requests with a size between 0 and S will be labeled as size/XS, PRs with a size between S and M will be labeled as S and so on. Defaults:
  • S: 10
  • M: 30
  • L: 100
  • XL: 500
  • XXL: 1000
• DIGEST_ISSUE_REPO: The location of the digest issue, by default the digest issue will be created and updated in the repo where the action is configured. If you would like the digest issue to be created and updated in a repo outside of where the action is configured, set this to the url of the repo (e.g. "https://github.com/octokit/rest.js") This requires ACCESS_TOKEN to be configured.
• ACCESS_TOKEN: This is a GitHub personal access token with the repo scope, stored as a secret in the repo where this action is configured.

You can configure the environment variables in the apply-pr-size-label.yml workflow file like this:

env:
  GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
  IGNORED: ".*\n!.gitignore\nyarn.lock\ngenerated/**"
  PROMPT_THRESHOLD: 500
  S: 10
  M: 30
  L: 100
  XL: 500
  XXL: 1000
  DIGEST_ISSUE_REPO: "https://github.com/octokit/rest.js"
  ACCESS_TOKEN: "${{ secrets.ACCESS_TOKEN }}"

Example configuration for action that publishes it's digest issue outside of the repo where it's configured

In this example we have two repos, one where the action will run (levindixon/demo-project) and another where the action will publish and maintain the digest issue (levindixon/demo-project-two).

A personal access token is generated with the repo scope and stored in levindixon/demo-project as a secret named ACCESS_TOKEN

Two workflow files are created in levindixon/demo-project:

.github/workflows/apply-pr-size-label.yml

name: Apply PR size label

on: pull_request

jobs:
  apply_pr_size_label:
    runs-on: ubuntu-latest
    steps:
      - uses: levindixon/pr-size-helper-action@v1.5.0
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/track-large-pr-reasons.yml

name: Track large PR reasons

on: issue_comment

jobs:
  track_large_pr_reasons:
    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '!reason') }}
    runs-on: ubuntu-latest
    steps:
      - uses: levindixon/pr-size-helper-action@v1.5.0
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
          ACCESS_TOKEN: "${{ secrets.ACCESS_TOKEN }}"
          DIGEST_ISSUE_REPO: "https://github.com/levindixon/demo-project-two"

The result is PRs will be labeled and watched for !reason comments in levindixon/demo-project, however !reason comments will be tracked in a digest issue located in levindixon/demo-project-two

This configuration allows you to configure the action in any number of repositories and maintain a single digest issue for any/all of them!

Acknowledgments

• 📝 Repo templated using actions/javascript-action 📝

• ✨ Guided by the Creating a JavaScript action guide ✨

• 🙇‍♂️ Ignore and labeling functionality forked from pascalgn/size-label-action 🙇‍♂️

• 💬 Prompt inspiration from CodelyTV/pr-size-labeler 💬

• 🏷 Size labels borrowed from kubernetes/kubernetes 🏷

License

MIT