noqcks/pull-request-size

Applies labels to Pull Requests based on the total lines of code changed.

Pull Request Size

Pull Request Size is a GitHub App that applies size/* labels to Pull Requests based on the total lines of code changed (additions and deletions).

Install

👉 Install via GitHub marketplace 🌟

This app is free to use for personal and public organization repos. There is a paid plan for use with private organization repos.

Sizing

Name	Description
size/XS	Denotes a PR that changes 0-9 lines.
size/S	Denotes a PR that changes 10-29 lines.
size/M	Denotes a PR that changes 30-99 lines.
size/L	Denotes a PR that changes 100-499 lines.
size/XL	Denotes a PR that changes 500-999 lines.
size/XXL	Denotes a PR that changes 1000+ lines.

Pull Request Size calculates the size of a PR as

total additions + total deletions - (all generated¹ file additions/deletions)

¹ A generated file is either one of the standard generated files as defined in noqcks/generated or defined with linguist-generated=true in a .gitattributes file.

Billing Issues

When an invoiced GitHub account tries to sign up for a subscription to Pull Request Size via the GitHub Marketplace they are met with the following message: "Unfortunately, invoiced customers cannot purchase paid plans on the Github Marketplace."

To get around GitHub billing limitations, we also offer payment via Stripe invoicing. Please follow these steps to complete:

1. Sign up for the Free plan on the GitHub Marketplace listing
2. Send an email to [email protected] with a company name, email of a billing contact, and the name of your GitHub Organization. Please indicate whether you would like a yearly or monthly invoice.
3. Once the Stripe invoice has been paid, you will be added to Pro plan.

Configuration

This app requires no configuration out of the box. However, you can exclude certain files from being counted towards a PR's size, and you can add custom labels in Github.

Excluding Files

If you have files that you would not like to be included in the calculation for a Pull Request's size, you can modify the .gitattributes file with the flag linguist-generated=true on your file or file pattern.

For example to mark all .meta files as generated, add this line to .gitattributes

*.meta linguist-generated=true

A .gitattributes file uses the same rules for matching as .gitignore files. See GitHub documenation on the linguist-generated flag for more info.

Custom Labels

You can set custom label names and colors by checking in the file .github/labels.yml to every repository you'd like to customize

XS:
  name: size/XS
  lines: 0
  color: 3CBF00
S:
  name: size/S
  lines: 10
  color: 5D9801
M:
  name: size/M
  lines: 30
  color: 7F7203
L:
  name: size/L
  lines: 100
  color: A14C05
XL:
  name: size/XL
  lines: 500
  color: C32607
XXL:
  name: size/XXL
  lines: 1000
  color: E50009

Size Comments

Size Comments are comments made on the size of a pull request. By default, Pull Request Size will not add any comments to a pull request. However, you can enable comments by adding a comment to a label in the .github/labels.yml file.

Any comment that is not empty wil be added to the pull request. Leave this key empty to disable comments for a size.

XXL:
  name: size/XXL
  lines: 1000
  color: E50009
  comment: |
    # Whoa! Easy there, Partner!
    This PR is too big. Please break it up into smaller PRs.

Feedback, suggestions and bug reports

Please create an issue here: https://github.com/noqcks/pull-request-size/issues

License

MIT © 2022 Benji Visser [email protected]

pull-request-size's Issues

Intermittent failures

This bot seems to skip applying labels to PRs intermittently.

Couldn't find any errors/logs anywhere so not sure where to look further.

Tests not run on new PR

CI tests did not run on this PR: https://github.com/noqcks/pull-request-size/pull/56/files

Inquiring About Options for One Acre Fund a Non-Profit Organization

Hi @noqcks,
The Pull-request-size has been a nifty tool in our development processes at One Acre Fund.
We are a non-profit organization working with small-holder farmers across Africa and our tech stack relies on open-source technologies and free tools.
I am just contacting you to explore any options available for organizations like ours.

image/svg+xml base64 to png javascript

Customize labels and size of changes

Would Pull Request Size consider supporting a configuration file that specifies the size of changes and corresponding labels to be used by the app, rather than the default configuration?

This feature would require permissions to read the entire repo content, since multiple file access appears unavailable currently.

Question: How to install for an organization?

Hi, I'm trying to install this app on this repo https://github.com/Axway/axway-open-docs which is owned by an organization. I am an admin of the repo but I am not an admin of the organization.

When I try to install this app, I only get an option to install it on my personal account, and not on the organization account.

But for other apps (such as Mergeable) I am able to install on the organization account.

Are additional permissions needed for this app or am I doing something wrong?

Uninstall

Hey there, Since we're not able to pay for the bot, we decided to uninstall it - but we're still getting the messages in every PR...
I could block the bot user but prefer not to...what am I doing wrong?

Remove travis-ci

Multiple labels being created

We only want one label!

XS->XXL changes and back

SupinePandora43/UltralightNet#45
(And few other PRs)

+14,990 −31,570
Is problem here?

Generated code still being counted

We use a lot of Go code generation, and the code gen headers match your regex in isGoCodgen, but the change still get counted. Any ideas?

Screenshot?

I would like a screenshot to show action!

exclude certain file types/extensions from line counts

I have a feature request for you: the ability to exclude certain file types/extensions from your line count calculations (if this is possible based on GH app permissions.) I would like to exclude things like Jest snapshots, lock file changes, etc., as they tend to artificially inflate otherwise simple PRs.

And thanks again for this GH extension!

Comments based on size

It would be nice to be able to add comments to the PR as well based on the size of the PR. Especially when it comes to large PRs, we would like to discourage people from making these and give them some strategies how to break up their work.

Stopped running on public repo magma/magma

This was working fine but stopped all of a sudden on this repo https://github.com/magma/magma/pulls. Can't find any specific errors and not sure how to troubleshoot. Any pointers will be very helpful.

Not working for my PRs

In my repo python-text-calculator seems like the PR Size bot is no longer doing its job...

My PR integrate mathmod is stuck on size/M label even though it changes more than 100 lines.

My PR Better base conversion has no PR Size label at all.

Suspending and unsuspending the app has no apparent effect.

A test PR with 148 commits does not get a label.

The bot does not seems to work when a generated file is committed

I'm not sure it's the expected behaviour but as soon there is a generated file in a PR (marked as linguist-generated=true in .gitattributes) the bot does not add/update a label.

When I remove the file from the PR, it adds/updates the label again.

419 files changed but the pr got labeled XS.

Link to the pr - K0-RR/ConsistencyPlus#39

Question: applying to old issues

First of all, thank you for Pull Request Size! It helps me keep a huge PR backlog organised.

Is there any way I can update old pull requests that were present before I installed the app?

I've found that I can individually edit a pull request's description to force-retrigger an update... but I was wondering if it was possible to do so en masse across all open issues somehow.

Upgrade node version

v12 support ended 2 months ago

https://endoflife.date/nodejs

Set colors of labels automatically

Start with bright green for smallest and turn to red when sizes are largest.

Upgraded to Github Enterprise, now I see an error

Everything was working just fine. I was using the integration on a private repo, and I was paying for it. Then I upgraded to Github Enterprise today. I started seeing the above error message on all the new PRs.

I tried uninstalling and re-installing the plugin on the Github Marketplace. However, Github knew that I still had an active billing with the integration despite me uninstalling it. I'm not sure what else I should be doing at this point to fix it.

could not purchase plan as an invoiced customer

I think you guy started to rollout the plan for Org private repository to pay for 50$ per year but there is an issue with invoiced customer like our Org, can you guys please help?

`yarn.lock` erroneously included in size

yarn.lock not being removed from total size calculation, and it should be!

How long does the robot applies the size label?

I have installed the robot and opened a PR about an hour ago, but there is no label been applied to my PR.