{"id":40543942,"url":"https://github.com/lerebear/sizeup-action","last_synced_at":"2026-01-20T23:17:58.552Z","repository":{"id":197293919,"uuid":"692353319","full_name":"lerebear/sizeup-action","owner":"lerebear","description":"Encourage digestible pull requests","archived":false,"fork":false,"pushed_at":"2025-12-29T17:22:41.000Z","size":7227,"stargazers_count":43,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-01T22:19:16.235Z","etag":null,"topics":["actions","code-quality","code-review","github-actions","teamwork"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lerebear.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-09-16T08:10:43.000Z","updated_at":"2025-12-29T17:13:48.000Z","dependencies_parsed_at":"2023-10-14T18:48:25.372Z","dependency_job_id":"389284b8-c645-4e43-915a-83b8a7d6a010","html_url":"https://github.com/lerebear/sizeup-action","commit_stats":null,"previous_names":["lerebear/sizeup-action"],"tags_count":37,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/lerebear/sizeup-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerebear%2Fsizeup-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerebear%2Fsizeup-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerebear%2Fsizeup-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerebear%2Fsizeup-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lerebear","download_url":"https://codeload.github.com/lerebear/sizeup-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerebear%2Fsizeup-action/sbom","scorecard":{"id":585515,"data":{"date":"2025-08-11","repo":{"name":"github.com/lerebear/sizeup-action","commit":"51fbb7850648509e9afabc6c464b81ca27e42c8b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Maintained","score":5,"reason":"6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 1/19 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/check-dist.yml:28","Warn: jobLevel 'statuses' permission set to 'write': .github/workflows/check-dist.yml:29","Warn: no topLevel permission defined: .github/workflows/check-dist.yml:1","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/sizeup.yaml:6"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-dist.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/lerebear/sizeup-action/check-dist.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-dist.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/lerebear/sizeup-action/check-dist.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-dist.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/lerebear/sizeup-action/check-dist.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/lerebear/sizeup-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/lerebear/sizeup-action/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sizeup.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/lerebear/sizeup-action/sizeup.yaml/main?enable=pin","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   2 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T20:24:08.937Z","repository_id":197293919,"created_at":"2025-08-20T20:24:08.937Z","updated_at":"2025-08-20T20:24:08.937Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28618798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T22:24:05.405Z","status":"ssl_error","status_checked_at":"2026-01-20T22:20:31.342Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","code-quality","code-review","github-actions","teamwork"],"created_at":"2026-01-20T23:17:57.431Z","updated_at":"2026-01-20T23:17:58.544Z","avatar_url":"https://github.com/lerebear.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SizeUp Action\n\nThis GitHub Action helps you encourage your contributors to open pull requests that will be easy to digest by reviewers. It does this by providing two  features:\n\n* Automatic labeling of pull requests with a size category.\n* Automatic commenting on pull requests that exceed a certain size threshold.\n\nAll aspects of this Action are [configurable](#configuration), including how sizes are calculated, what thresholds to use for each size category, and whether or not to actually perform the above automations or only to log them.\n\n## Usage\n\n[Create an Actions workflow](https://docs.github.com/en/actions/quickstart) in your desired repository (e.g. `.github/workflows/sizeup.yaml`) with the following contents:\n\n```yaml\nname: SizeUp\n\non:\n  pull_request:\n    types:\n      - opened\n      - synchronize\n      - reopened\n      - edited\n      - ready_for_review\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  sizeup:\n    name: Estimate reviewability\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Run sizeup\n        # TODO: Replace the version below with your desired version.\n        #\n        # For more details please see:\n        # https://github.com/lerebear/sizeup-action/blob/main/README.md#versioning\n        uses: lerebear/sizeup-action@v0.8.11\n\n        with:\n          # A GitHub API token capable of reading pull requests from this\n          # repository.\n          #\n          # In this example, we've used the `permissions` key above to request\n          # the necessary permissions for the default `GITHUB_TOKEN` secret,\n          # and then we've passed it along here.\n          #\n          # This input is required.\n          token: \"${{ secrets.GITHUB_TOKEN }}\"\n\n          # Options that will be forwarded to `git diff` when computing the\n          # diff to evaluate with this workflow.\n          #\n          # Defaults to \"--ignore-space-change\", which ignores lines of the\n          # diff in which the only change is to the amount of whitespace on the\n          # line.\n          git-diff-options: \"--ignore-space-change\"\n\n          # Path to a YAML configuration file for this workflow that is stored\n          # in this repository.\n          #\n          # This input defaults to \"\", which instructs the workflow to use the\n          # built-in default configuration.\n          configuration-file-path: \".github/sizeup.yaml\"\n```\n\nThis will use [`sizeup`](https://github.com/lerebear/sizeup-core) to estimate the reviewability of any pull request opened on your repository using a YAML configuration file found at `.github/sizeup.yaml`. The format of the configuration file is described below.\n\nPlease note that the workflow configuration above does not use [`actions/checkout`](https://github.com/actions/checkout). This is because `actions/checkout` does not provide enough options to make a customized `git diff` command maximally efficient. Instead, this Action will perform its own clone, fetch, and checkout operations using the provided `token`.\n\n## Versioning\n\nThis Action follows [semantic versioning conventions](https://semver.org), but is still \u003c1.0. Thus, as is common for pre-1.0 software, breaking changes are  sometimes introduced in minor version bumps (although patch version bumps will only contain backwards-compatible bug fixes). Please bear this in mind when choosing the version of this Action that you would like to use.\n\n## Configuration\n\nThis Action can be configured by specifying the `configuration-file-path` input. The value of that input should be the path to a YAML file that contains configuration for this Action and the underlying `sizeup` library.\n\nAn example configuration file looks like this:\n\n```yaml\nlabeling:\n\n  # Whether or not to add a label to each pull request to indicate its assessed category\n  applyCategoryLabels: true\n\n  # The prefix to add to each category label that we apply.\n  categoryLabelPrefix: \"sizeup/\"\n\ncommenting:\n\n  # Whether or not to comment on pull requests that exceed the configured score threshold\n  addCommentWhenScoreThresholdHasBeenExceeded: true\n\n  # The threshold above which we will add a comment to the assessed pull request.\n  scoreThreshold: 100\n\n  # The template for the comment that should be added to each pull request that\n  # exceeds the score threshold. Any of the following variables can be included\n  # in the template with surrounding curly braces (e.g. {{author}}) in order to\n  # interpolate a computed value into the comment:\n  #\n  #   - author\n  #   - threshold\n  #   - score\n  #   - category\n  #   - score-details\n  commentTemplate: |\n    👋 @{{author}} this pull request exceeds the configured reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n# List of pull request authors for whom we should run this workflow. When this configuration key is omitted, the workflow runs for pull requests opened by all authors.\noptIns:\n  - lerebear\n  - glortho\n\n# Configuration for how to evaluate pull requests.\n# This is of the same format that `sizeup-core` accepts directly.\nsizeup:\n  categories:\n    - name: extra small\n      lte: 10\n      label:\n        name: xs\n        color: 3cbf00\n    - name: small\n      lte: 30\n      label:\n        name: s\n        color: 5d9801\n    - name: medium\n      lte: 100\n      label:\n        name: m\n        color: 7f7203\n    - name: large\n      lte: 500\n      label:\n        name: l\n        color: a14c05\n    - name: extra large\n      label:\n        name: xl\n        color: c32607\n  ignoredFilePatterns:\n    - CODEOWNERS\n    - SERVICEOWNERS\n  testFilePatterns:\n    - \"*_test.rb\"\n  scoring:\n    formula: \"- - + additions deletions comments whitespace\"\n```\n\nThe default configuration that is used when no configuration file is provided can be found in [`src/config/default.yaml`](./src/config/default.yaml).\n\nThe full specification for the configuration file, which includes options that are not specified in the example above or in the default configuration, is provided by the JSON schema at [`src/config/schema.json`](./src/config/schema.json).\n\nFor details about what configuration can be provided under the `sizeup` key, please see the [`sizeup-core` library's configuration guide](https://github.com/lerebear/sizeup-core#configuration).\n\n## Development\n\nFor notes on how to develop this library, please see [these docs](https://github.com/lerebear/sizeup-action/blob/main/docs/development.md).\n\n## Acknowledgements\n\nThis tool was developed in collaboration with @glortho as a successor to https://github.com/glortho/pr-size-helper-action 🙌.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flerebear%2Fsizeup-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flerebear%2Fsizeup-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flerebear%2Fsizeup-action/lists"}