{"id":26258767,"url":"https://github.com/ppremk/lfs-warning","last_synced_at":"2025-04-30T04:47:01.418Z","repository":{"id":39877198,"uuid":"248356700","full_name":"ppremk/lfs-warning","owner":"ppremk","description":"GitHub Action to detect Large Files in a Pull Request","archived":false,"fork":false,"pushed_at":"2024-09-07T09:39:08.000Z","size":42354,"stargazers_count":35,"open_issues_count":9,"forks_count":21,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-30T04:46:53.387Z","etag":null,"topics":["github","github-actions","lfs-warning"],"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/ppremk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-18T22:27:03.000Z","updated_at":"2025-03-20T13:44:22.000Z","dependencies_parsed_at":"2024-04-04T18:27:28.783Z","dependency_job_id":"a3d4d255-72d3-4227-aa38-ee7ec0bfeb05","html_url":"https://github.com/ppremk/lfs-warning","commit_stats":null,"previous_names":["actionsdesk/lfs-warning"],"tags_count":8,"template":false,"template_full_name":"actions/javascript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppremk%2Flfs-warning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppremk%2Flfs-warning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppremk%2Flfs-warning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppremk%2Flfs-warning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ppremk","download_url":"https://codeload.github.com/ppremk/lfs-warning/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251644826,"owners_count":21620630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["github","github-actions","lfs-warning"],"created_at":"2025-03-13T22:14:03.584Z","updated_at":"2025-04-30T04:47:01.392Z","avatar_url":"https://github.com/ppremk.png","language":"TypeScript","readme":"# LFS-Warning action\n\nThis action works to prevent both:\n\n- Large files that are not LFS tracked\n- Files that are LFS tracked\n\nfrom being checked-in in non-pointer format/not stored in LFS. The latter happens if the client does not have git-lfs installed.\n\n## How it works\n\nThis action scans files in commits of a pull request and will mark the pull request as failed, add a `lfs-detected!` label and reply with an issue comment if any of the following is true about any of the pull request files:\n\n- The file size is greater than the configured file size limit threshold.\n- The file is tracked in LFS but is being checked-in as a regular file\n  - the current implementation of this check is that the file has git attribute `filter: lfs` but does not contain the string `version https://git-lfs.github.com/spec/v1`\n\n![pr-with-lfs-detected](https://user-images.githubusercontent.com/5770369/77542326-4cc7a400-6ea6-11ea-9d16-aa99be9b3240.png)\n\nNote: Remember to configure the branch protection rule and select the `LFS-warning` status when you enable the `Required status check to pass` option.\n\n![status-check](https://user-images.githubusercontent.com/5770369/77543439-fc514600-6ea7-11ea-8b33-ac9dedd98fd4.png)\n\n## Inputs\n\n### `filesizelimit`\n\nOptional. set's the file size limit threshold. Accepts `b` (bytes), `mb` (megabytes) and `gb` (gigabytes) as units of measurement, if omitted interprets as bytes.\n\nDefault `10mb`.\n\n### `token`\n\nOptional. Takes a valid **GitHub Token** from the Repo by default.\n\n### `exclusionPatterns`\n\nOptional. A newline delimited list of glob patterns that match checked in files to exclude form LFS Warning.\n\n### `labelName`\n\nOptional. The name of the label, defaults to lfs-detected!\n\n### `labelColor`\n\nOptional. The color of the label, defaults to ff1493.\n\n## Outputs\n\n### `lfsFiles`\n\nReturns an array of possible detected large file(s)\n\n## Usage\n\nConsume the action by referencing the stable release\n\n```yaml\nuses: ppremk/lfs-warning@v3.2\nwith:\n  token: ${{ secrets.GITHUB_TOKEN }} # Optional\n  filesizelimit: 10MB\n  exclusionPatterns: |\n    **/*.png\n```\n\n## Contributers\n\n- [@froi](https://github.com/froi)\n- [@decyjphr](https://github.com/decyjphr)\n- [@naseemkullah](https://github.com/naseemkullah)\n- [@TomerFi](https://github.com/TomerFi)\n- [@davidlj95](https://github.com/davidlj95) \n- [@SkyTrix](https://github.com/SkyTrix)\n- [@srz-zumix](https://github.com/srz-zumix)\n- [@zzgab](https://github.com/zzgab)\n- [@samthebest](https://github.com/samthebest)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppremk%2Flfs-warning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fppremk%2Flfs-warning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppremk%2Flfs-warning/lists"}