{"id":28530648,"url":"https://github.com/pb33f/vacuum-action","last_synced_at":"2026-01-31T19:01:07.402Z","repository":{"id":297558641,"uuid":"997102465","full_name":"pb33f/vacuum-action","owner":"pb33f","description":"The official GitHub action for vacuum, OpenAPI linter","archived":false,"fork":false,"pushed_at":"2025-06-06T04:20:54.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-06T05:24:54.699Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/pb33f.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,"zenodo":null}},"created_at":"2025-06-06T00:53:15.000Z","updated_at":"2025-06-06T04:20:56.000Z","dependencies_parsed_at":"2025-06-06T05:25:02.720Z","dependency_job_id":null,"html_url":"https://github.com/pb33f/vacuum-action","commit_stats":null,"previous_names":["pb33f/vacuum-action"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/pb33f/vacuum-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pb33f%2Fvacuum-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pb33f%2Fvacuum-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pb33f%2Fvacuum-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pb33f%2Fvacuum-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pb33f","download_url":"https://codeload.github.com/pb33f/vacuum-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pb33f%2Fvacuum-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28950279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T18:30:42.805Z","status":"ssl_error","status_checked_at":"2026-01-31T18:30:19.593Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2025-06-09T14:37:17.404Z","updated_at":"2026-01-31T19:01:07.398Z","avatar_url":"https://github.com/pb33f.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Official vacuum OpenAPI linter GitHub Action\n\nGot an **OpenAPI** spec in your repository? Want to lint it with vacuum? This GitHub Action will do just that. \n\n- Super fast\n- Super simple\n- Super useful\n\nAll you need to do is add the action to your repo via a workflow via `pb33f/vacuum-action@v2`\n\nHere are the configurable properties you can use in your workflow:\n\n| Property         | Type      | Required | Description                                                                                                                    |\n|------------------|-----------|----------|--------------------------------------------------------------------------------------------------------------------------------|\n| `openapi_path`   | `string`  | **true** | The path to your OpenAPI spec file, relative to the root of your repository.                                                   |\n| `github_token`   | `string`  | **true** | The GitHub token to use for authentication. This is required to post comments on pull requests.                                |\n| `ruleset`        | `string`  | _false_  | The path to a custom ruleset file, relative to the root of your repository. If not provided, the default ruleset will be used. | \n| `show_rules`     | `boolean` | _false_  | If set to `true`, the action will show the rules that were applied. Defaults to `false`                                        |\n| `fail_on_error`  | `boolean` | _false_  | If set to `true`, the action will fail if any errors are detected in the OpenAPI spec. Defaults to `true`                      |\n| `minimum_score`  | `number`  | _false_  | The minimum score required to not fail the check. Defaults to `70`.                                                            |\n| `print_logs`     | `boolean` | _false_  | If set to `true`, the action will print the markdown report to the runner logs. Defaults to `true`                             |\n\n---\n\n## Example Workflow\n\n```yaml\nname: \"Lint OpenAPI spec with vacuum\"\n\non:\n  push:\n    branches:\n      - main\n  pull_request:\n    branches:\n      - main\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  vacuum-lint:\n    name: Run OpenAPI linting with vacuum\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v3\n\n      - name: Run OpenAPI lint with vacuum\n        uses: pb33f/vacuum-action@v2\n        with:\n          openapi_path: \"specs/openapi.yaml\"\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Example Workflow with optional parameters\n\n```yaml\nname: \"Lint OpenAPI spec with vacuum\"\n\non:\n  push:\n    branches:\n      - main\n  pull_request:\n    branches:\n      - main\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  vacuum-lint:\n    name: Run OpenAPI linting with vacuum\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v3\n\n      - name: Run OpenAPI lint with vacuum\n        uses: pb33f/vacuum-action@v2\n        with:\n          openapi_path: \"specs/openapi.yaml\"\n          ruleset: \"rulesets/vacuum-ruleset.yaml\"\n          show_rules: true\n          fail_on_error: true\n          minimum_score: 90\n          print_logs: true\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpb33f%2Fvacuum-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpb33f%2Fvacuum-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpb33f%2Fvacuum-action/lists"}