Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisreddington/validate-devcontainer
A GitHub Action which reads a repository's devcontainer.json and validates that it contains specific configuration.
https://github.com/chrisreddington/validate-devcontainer
codespace codespaces devcontainer devcontainers github-actions
Last synced: 9 days ago
JSON representation
A GitHub Action which reads a repository's devcontainer.json and validates that it contains specific configuration.
- Host: GitHub
- URL: https://github.com/chrisreddington/validate-devcontainer
- Owner: chrisreddington
- License: mit
- Created: 2024-11-05T17:31:19.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T06:19:45.000Z (14 days ago)
- Last Synced: 2025-01-06T14:28:15.444Z (14 days ago)
- Topics: codespace, codespaces, devcontainer, devcontainers, github-actions
- Language: TypeScript
- Homepage:
- Size: 445 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Validate Dev Container Configuration
[](https://github.com/chrisreddington/validate-devcontainer)
[](https://github.com/chrisreddington/validate-devcontainer/actions/workflows/check-dist.yml)
[](https://github.com/chrisreddington/validate-devcontainer/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
[](https://github.com/chrisreddington/validate-devcontainer/actions/workflows/baseline.yml)
A GitHub Action to validate Dev Container configuration. This action can check
for required Visual Studio Code extensions, validate task configuration and
check for required features in devcontainer.json files.
## Features
- Validates presence of required Visual Studio Code extensions in
devcontainer.json
- Optional validation of common development tasks (build, test, run)
- Customizable devcontainer.json path
- Configurable extension requirements
- Validates presence of required devcontainer features in devcontainer.json
## Usage
```yaml
Steps:
- uses: actions/checkout@v4
- name: Validate Dev Container
uses: chrisreddington/[email protected]
with:
# Required Visual Studio Code extensions (comma-separated)
required-extensions: 'GitHub.codespaces,GitHub.vscode-github-actions'
# Optional: Path to devcontainer.json
devcontainer-path: '.devcontainer/devcontainer.json'
# Optional: Enable task validation
validate-tasks: 'true'
# Optional: Required devcontainer features (comma-separated)
required-features: 'ghcr.io/devcontainers/features/github-cli:1,ghcr.io/devcontainers-contrib/features/prettier:1'
```
### Inputs
| Input | Description | Required | Default |
| --------------------- | -------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `required-extensions` | Comma-separated list of required Visual Studio Code extensions | Yes | GitHub.codespaces,github.vscode-github-actions,GitHub.copilot,GitHub.copilot-chat,github.copilot-workspace,GitHub.vscode-pull-request-github,GitHub.remotehub,GitHub.vscode-codeql |
| `devcontainer-path` | Path to devcontainer.json file | No | .devcontainer/devcontainer.json |
| `validate-tasks` | Enable validation of build, test, and run tasks | No | false |
| `required-features` | Comma-separated list of required devcontainer features | No | |
#### Extension Validation
The action checks for the presence of the required extensions in the
`required-extensions` input. The input is a comma-separated list of extension
IDs. The action checks for the presence of each extension in the
`devcontainer.json` file.
#### Task Validation
When `validate-tasks` is set to `true`, the action checks for the following
required tasks in devcontainer.json:
- `build`
- `test`
- `run`
Each task must be defined as a string value.
#### Feature Validation
The action checks for the presence of the required features in the
`required-features` input. The input is a comma-separated list of feature IDs.
The action checks for the presence of each feature in the `devcontainer.json`
file.
#### Example devcontainer.json
```json
{
"customizations": {
"vscode": {
"extensions": ["GitHub.codespaces", "GitHub.vscode-github-actions"]
}
},
"tasks": {
"build": "npm run build",
"test": "npm test",
"run": "npm start"
},
"features": {
"ghcr.io/devcontainers/features/github-cli:1": {},
"ghcr.io/devcontainers-contrib/features/prettier:1": {}
}
}
```
## Development
1. Install dependencies: npm install
1. Run tests: npm test
1. Build the action: npm run bundle
## License
MIT License - see [LICENSE](LICENSE) for details.