Skip to main content

​
Adding a New Container

To add a new container to this repository, follow these steps:

​
Step 1: Create Container Directory

Create a new directory following the naming convention {container-name}: 
mkdir your-container-name
cd your-container-name

​
Step 2: Create Dockerfile

Create a Dockerfile with required OCI labels. Use dev-container-node/Dockerfile as a reference for the structure and required labels.

​
Step 3: Create Container README

Create a README.md in your container directory with:
  • Container description
  • Usage instructions
  • Environment variables
  • Examples

​
Step 4: Update Release Please Configuration

Add your container to release-please-config.json: 
{
  "packages": {
    "dev-container-node": {
      "release-type": "simple",
      "package-name": "dev-container-node"
    },
    "your-container-name": {
      "release-type": "simple",
      "package-name": "your-container-name"
    }
  }
}

​
Step 5: Update GitHub Workflow

Update the container matrix in all workflows so the new container builds:

​
docker-build-push.yml

Add your container to strategy.matrix.container. This controls build/push and tag matching for {container}@x.y.z.

​
ci.yml

Add your container to strategy.matrix.container for CI build validation.

​
Step 6: Update Dependabot (Optional)

If your container has dependencies that need monitoring, update .github/dependabot.yml to include your container directory.

​
Resources

For detailed instructions and examples, see the containers repository README.