Skip to content

README.md

Latest commit

 

History

History
36 lines (26 loc) · 1.4 KB

README.md

File metadata and controls

36 lines (26 loc) · 1.4 KB
Raw

Validate DevSchema GitHub Action

ci Validate DevSchema Test

This GitHub Action validates a devcontainer.json file against a schema by first ensuring the JSON is valid.

Inputs

Note: The default schema has been tested and verified to work. If you customize the schema, ensure that it is a valid JSON schema to avoid validation errors.

Name Description Required Default
schema Path or URL to the JSON schema. No https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json
data Path or URL to the JSON data. No devcontainer/devcontainer.json
verbose Enable verbose output (true/false). No false
python-version Python version to use. Allowed versions are: 3.10, 3.11, 3.12, 3.13, 3.14. No 3.14

Usage

jobs:
  validate-schema:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v7

      - name: Validate Devcontainer Schema
        uses: actionsforge/actions-validate-devschema@v1
        with:
          verbose: true

License

This project is licensed under the MIT License. See the LICENSE file for details.