{"id":29142394,"url":"https://github.com/bufbuild/buf-lint-action","last_synced_at":"2025-06-30T19:37:38.224Z","repository":{"id":38831905,"uuid":"348845617","full_name":"bufbuild/buf-lint-action","owner":"bufbuild","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-24T16:45:48.000Z","size":1755,"stargazers_count":28,"open_issues_count":6,"forks_count":10,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-06-03T23:23:00.392Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bufbuild.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-17T20:38:24.000Z","updated_at":"2025-04-24T16:02:25.000Z","dependencies_parsed_at":"2024-03-25T15:14:56.983Z","dependency_job_id":"6c570ab6-299c-4134-99b0-3e5a028f0a49","html_url":"https://github.com/bufbuild/buf-lint-action","commit_stats":{"total_commits":40,"total_committers":10,"mean_commits":4.0,"dds":0.675,"last_synced_commit":"b838cb4dcab099131c72d29ae597be86e39f37dd"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/bufbuild/buf-lint-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufbuild%2Fbuf-lint-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufbuild%2Fbuf-lint-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufbuild%2Fbuf-lint-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufbuild%2Fbuf-lint-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bufbuild","download_url":"https://codeload.github.com/bufbuild/buf-lint-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufbuild%2Fbuf-lint-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260579502,"owners_count":23031193,"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":[],"created_at":"2025-06-30T19:37:29.582Z","updated_at":"2025-06-30T19:37:38.210Z","avatar_url":"https://github.com/bufbuild.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `buf-lint-action`\n\n\u003e [!NOTE]\n\u003e This action has been deprecated in favor of the [`buf-action`][buf-action] which combines the\n\u003e functionality of `buf-lint-action` with the ability to run Buf commands in the same step. Please\n\u003e see the [migration guide][buf-action-migration] for more information.\n\nThis [Action] enables you to [lint] Protobuf files with [Buf] in your GitHub Actions pipelines. If\nit detects violations of your configured [lint rules][lint.rules], it automatically creates inline\ncomments under the rule-breaking lines in your `.proto` files.\n\n![Per-line pull request comments](./static/img/lint.png)\n\n## Usage\n\nHere's an example usage of `buf-lint-action`:\n\n```yaml\non: pull_request # Apply to all pull requests\njobs:\n  lint-protos:\n    # Run `git checkout`\n    - uses: actions/checkout@v2\n    # Install the `buf` CLI\n    - uses: bufbuild/buf-setup-action@v1\n    # Lint your Protobuf sources\n    - uses: bufbuild/buf-lint-action@v1\n```\n\nWith this configuration, the `buf` CLI runs the lint checks specified in your [`buf.yaml`][buf-yaml]\nconfiguration file. If any violations are detected, `buf-lint-action` creates inline comments under\nthe rule-breaking lines in your `.proto` files in the pull request.\n\n## Prerequisites\n\nFor `buf-lint-action` to work, you need to install the `buf` CLI in the GitHub Actions Runner first.\nWe recommend using [`buf-setup-action`][buf-setup] to install it (as in the example\n[above](#usage)).\n\n## Configuration\n\nParameter | Description | Required | Default\n:---------|:------------|:---------|:-------\n`input` | The path of the [Buf input][input] you want to lint check | | `.`\n`buf_token` | The Buf [authentication token][token] used for any private [input] | ✅ |\n\n\u003e These parameters are derived from [`action.yml`](./action.yml)\n\n## Common tasks\n\n### Run against input in sub-directory\n\nSome repositories are structured in such a way that their [`buf.yaml`][buf-yaml] is defined in a\nsub-directory alongside their Protobuf sources, such as a `proto` directory. Here's an example:\n\n```sh\n$ tree\n.\n└── proto\n    ├── acme\n    │   └── weather\n    │       └── v1\n    │           └── weather.proto\n    └── buf.yaml\n```\n\nIn that case, you can target the `proto` sub-directory by setting `input` to `proto`:\n\n```yaml\nsteps:\n  - uses: actions/checkout@v2\n  - uses: bufbuild/buf-setup-action@v1\n  # Run lint only in the `proto` sub-directory\n  - uses: bufbuild/buf-lint-action@v1\n    with:\n      input: proto\n```\n\n[action]: https://docs.github.com/actions\n[buf-action]: https://github.com/bufbuild/buf-action\n[buf-action-migration]: https://github.com/bufbuild/buf-action/blob/main/MIGRATION.md#buf-lint-action\n[buf]: https://buf.build\n[buf-breaking]: https://github.com/marketplace/actions/buf-breaking\n[buf-push]: https://github.com/marketplace/actions/buf-push\n[buf-setup]: https://github.com/bufbuild/buf-setup-action\n[buf-yaml]: https://docs.buf.build/configuration/v1/buf-yaml\n[input]: https://docs.buf.build/reference/inputs\n[lint]: https://docs.buf.build/lint/usage\n[lint.rules]: https://docs.buf.build/lint/rules\n[token]: https://docs.buf.build/bsr/authentication#create-an-api-token\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbufbuild%2Fbuf-lint-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbufbuild%2Fbuf-lint-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbufbuild%2Fbuf-lint-action/lists"}