Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (51 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.54 KB

Contribute to Developer Images

Developer Base Image

Red Hat Universal Base Image (UBI) based images

Available versions:

Build with Docker buildkit:

UBI 9:

$ cd base/ubi9
$ DOCKER_BUILDKIT=1 docker image build --progress=plain -t quay.io/devfile/base-developer-image:ubi9-latest .

UBI 10:

$ cd base/ubi10
$ DOCKER_BUILDKIT=1 docker image build --progress=plain -t quay.io/devfile/base-developer-image:ubi10-latest .

Developer Universal Image

Red Hat Universal Base Image (UBI) based image (quay.io/devfile/universal-developer-image:ubi9-latest)

Build with Docker buildkit:

$ cd universal/ubi9
$ DOCKER_BUILDKIT=1 docker image build --progress=plain -t quay.io/devfile/universal-developer-image:ubi9-latest .

To build for a specific architecture:

UBI 9:

# amd64
$ DOCKER_BUILDKIT=1 docker image build --platform linux/amd64 --progress=plain -t quay.io/devfile/universal-developer-image:ubi9-latest .

# arm64
$ DOCKER_BUILDKIT=1 docker image build --platform linux/arm64 --progress=plain -t quay.io/devfile/universal-developer-image:ubi9-latest .

UBI 10 Base Image:

# amd64
$ DOCKER_BUILDKIT=1 docker image build --platform linux/amd64 --progress=plain -t quay.io/devfile/base-developer-image:ubi10-latest .

# arm64
$ DOCKER_BUILDKIT=1 docker image build --platform linux/arm64 --progress=plain -t quay.io/devfile/base-developer-image:ubi10-latest .

Registry Configuration

Using Custom Registry

The build workflows support custom container registries through repository variables. This is useful for forks that want to publish to their own registry.

To configure:

  1. In your fork, go to Settings → Secrets and Variables → Actions → Variables
  2. Add a repository variable: REGISTRY = your-registry.com/your-namespace
  3. All workflows will automatically use your custom registry

Example: Setting REGISTRY to ghcr.io/youruser will publish images to:

  • ghcr.io/youruser/base-developer-image:ubi9-latest
  • ghcr.io/youruser/base-developer-image:ubi10-latest
  • ghcr.io/youruser/universal-developer-image:ubi9-latest