Skip to content

GitHub Action to validate devcontainer and VS Code configurations for JSON syntax and schema compliance

License

Notifications You must be signed in to change notification settings

actionsforge/actions-validate-devschema

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

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.9, 3.10, 3.11, 3.12, 3.13. No 3.13

Usage

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

      - 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.

About

GitHub Action to validate devcontainer and VS Code configurations for JSON syntax and schema compliance

Resources

License

Stars

Watchers

Forks

Packages

No packages published