Dev Container Features

This repository contains a collection of dev container features

Features

Each sub-section below shows a sample devcontainer.json alongside example usage of the Feature.

codeql

Running codeql inside the built container will install the CodeQL CLI and CodeQL language packs bundle.

{
    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
    "features": {
        "ghcr.io/perdiga/devcontainer-features/codeql:1": 
    }
}

Repo and Feature Structure

This repository has a src folder. Each Feature has its own sub-folder, containing at least a devcontainer-feature.json and an entrypoint script install.sh.

├── src
│   ├── codeql
│   │   ├── devcontainer-feature.json
│   │   └── install.sh
|   ├── ...
│   │   ├── devcontainer-feature.json
│   │   └── install.sh
...

An implementing tool will composite the documented dev container properties from the feature's devcontainer-feature.json file, and execute in the install.sh entrypoint script in the container during build time. Implementing tools are also free to process attributes under the customizations property as desired.

Options

All available options for a Feature should be declared in the devcontainer-feature.json. The syntax for the options property can be found in the devcontainer Feature json properties reference.

Options are exported as Feature-scoped environment variables. The option name is captialized and sanitized according to option resolution.

Distributing Features

Versioning

Features are individually versioned by the version attribute in a Feature's devcontainer-feature.json. Features are versioned according to the semver specification. More details can be found in the dev container Feature specification.

Publishing

This repo contains a GitHub Action workflow that will publish each Feature to GHCR.

Allow GitHub Actions to create and approve pull requests should be enabled in the repository's Settings > Actions > General > Workflow permissions for auto generation of src/<feature>/README.md per Feature (which merges any existing src/<feature>/NOTES.md).

By default, each Feature will be prefixed with the <owner/<repo> namespace.

The provided GitHub Action will also publish a third "metadata" package with just the namespace, eg: ghcr.io/Perdiga/devcontainer-features. This contains information useful for tools aiding in Feature discovery.

'Perdiga/devcontainer-features' is known as the feature collection namespace.

Adding Features to the Index

This repo is listed on dev container public index so that other community members can find them. If you need to update it, open a PR to modify the collection-index.yml file