Collection of JSON schemas for validating configuration files and data structures.
schemas/
├── schemas/
│ └── awesome-repositories/
│ └── awesome-repositories.schema.json
├── examples/
│ └── awesome-repositories/
│ ├── valid-example.yaml
│ └── invalid-example.yaml
├── docs/
│ └── awesome-repositories.md
└── README.md
- File:
schemas/awesome-repositories/awesome-repositories.schema.json - Purpose: Validation of repository catalogs with categories and subcategories
- Documentation: docs/awesome-repositories.md
- Examples: examples/awesome-repositories/
Add to the beginning of your YAML file:
# yaml-language-server: $schema=https://raw.githubusercontent.com/abordage/schemas/main/schemas/awesome-repositories/awesome-repositories.schema.jsonUse the schema-validation-action for automated validation:
# GitHub Actions example
- name: Validate awesome repositories
uses: cardinalby/schema-validator-action@v3
with:
file: 'config/repositories.yaml'
schema: 'https://raw.githubusercontent.com/abordage/schemas/main/schemas/awesome-repositories/awesome-repositories.schema.json'You can also validate multiple files at once:
- name: Validate all repository configs
uses: cardinalby/schema-validator-action@v3
with:
file: 'configs/*.yaml'
schema: 'https://raw.githubusercontent.com/abordage/schemas/main/schemas/awesome-repositories/awesome-repositories.schema.json'- Create schema in
schemas/{schema-name}/folder - Add examples to
examples/{schema-name}/ - Create documentation in
docs/{schema-name}.md - Update this README
- Submit awesome-repositories schema to SchemaStore for wider community access