{"id":18447799,"url":"https://github.com/stoplightio/spectral-action","last_synced_at":"2025-05-16T18:06:06.089Z","repository":{"id":37493451,"uuid":"170991023","full_name":"stoplightio/spectral-action","owner":"stoplightio","description":"GitHub Action wrapper for Spectral - a JSON/YAML/OpenAPI/AsyncAPI/etc linter with custom rule support.","archived":false,"fork":false,"pushed_at":"2024-11-18T22:46:06.000Z","size":1596,"stargazers_count":95,"open_issues_count":23,"forks_count":46,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-11T18:48:13.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://stoplight.io/open-source/spectral","language":"JavaScript","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/stoplightio.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":"2019-02-16T10:27:47.000Z","updated_at":"2025-05-05T18:15:59.000Z","dependencies_parsed_at":"2024-06-18T13:49:49.099Z","dependency_job_id":"a421bf72-d918-4b5c-bb9e-21816aa69a42","html_url":"https://github.com/stoplightio/spectral-action","commit_stats":{"total_commits":244,"total_committers":23,"mean_commits":"10.608695652173912","dds":0.4795081967213115,"last_synced_commit":"aec81028b28c9dc3de7b89bc25f4239bacfe9c19"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoplightio%2Fspectral-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoplightio%2Fspectral-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoplightio%2Fspectral-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoplightio%2Fspectral-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stoplightio","download_url":"https://codeload.github.com/stoplightio/spectral-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582904,"owners_count":22095518,"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":"2024-11-06T07:14:27.953Z","updated_at":"2025-05-16T18:06:06.032Z","avatar_url":"https://github.com/stoplightio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spectral Linter Action\n\nThis action uses [Spectral](https://github.com/stoplightio/spectral) from [Stoplight](https://stoplight.io/) to lint your OpenAPI documents, or any other JSON/YAML files.\n\n![](./image.png)\n\n## Usage\n\nSee [action.yml](action.yml)\n\n```yaml\nname: Run Spectral on Pull Requests\n\non:\n  - pull_request\n\njobs:\n  build:\n    name: Run Spectral\n    runs-on: ubuntu-latest\n    steps:\n      # Check out the repository\n      - uses: actions/checkout@v3\n\n      # Run Spectral\n      - uses: stoplightio/spectral-action@latest\n        with:\n          file_glob: 'doc/api/*.yaml'\n```\n\n### Inputs\n\n- **file_glob:** Pattern describing the set of files to lint. Defaults to `*.oas.{json,yml,yaml}`. (_Note:_ Pattern syntax is documented in the [fast-glob](https://www.npmjs.com/package/fast-glob) package documentation)\n- **spectral_ruleset:** Custom ruleset to load in Spectral. When unspecified, will try to load the default `.spectral.yaml` ruleset if it exists.\n\n## Configuration\n\nSpectral Action will respect your [Spectral Rulesets](https://meta.stoplight.io/docs/spectral/01baf06bdd05a-rulesets), which can be defined, extended, and overriden by placing `.spectral.yml` in the root of your repository.\n\nHowever, if you'd like to simply use a core ruleset without additional configuration, create a `.spectral.yml` in you repository's root with only the contents: `extends: [\"spectral:{rulesetTagHere}\"]`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstoplightio%2Fspectral-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstoplightio%2Fspectral-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstoplightio%2Fspectral-action/lists"}