https://github.com/chillicream/nitro-schema-validate
https://github.com/chillicream/nitro-schema-validate
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/chillicream/nitro-schema-validate
- Owner: ChilliCream
- License: mit
- Created: 2026-03-25T20:12:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-05-27T15:36:59.000Z (21 days ago)
- Last Synced: 2026-05-27T17:19:09.260Z (21 days ago)
- Language: TypeScript
- Size: 6.04 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nitro Schema Validate
A GitHub Action that validates GraphQL schemas against the Nitro registry.
## Usage
```yaml
- uses: ChilliCream/nitro-schema-validate@v16
with:
stage:
api-id:
schema-file: ./schema.graphql
api-key:
# Optional
comment-mode: none
cloud-url:
```
## Inputs
| Name | Required | Description |
| ------------- | -------- | ------------------------------------------------------------------------------- |
| `stage` | Yes | The name of the stage |
| `api-id` | Yes | The ID of the API |
| `schema-file` | Yes | The path to the graphql file with the schema definition |
| `api-key` | Yes | API key for authentication |
| `comment-mode` | No | Pull request feedback mode on failure: `comment`, `review`, or `none` (default) |
| `cloud-url` | No | The URL of the Nitro registry |
If you self-host Nitro or use a dedicated hosted instance, you can specify the `cloud-url` input to point to your instance.
## Pull Request comments
Use `comment-mode` to control pull request feedback behavior.
`comment-mode: comment` comments on the pull request - requires `issues: write` permissions
`comment-mode: review` creates a pull request review with a comment - requires `pull-requests: write` permissions
Example for `comment-mode: comment`:
```yaml
jobs:
validate:
permissions:
contents: read
issues: write
```
Example for `comment-mode: review`:
```yaml
jobs:
validate:
permissions:
contents: read
pull-requests: write
```
> Note: When you define job-level `permissions`, GitHub no longer applies the default permission set for that job. Make sure to explicitly include every permission the job needs (for example `contents: read`).