Skip to content

Commit bf495a5

Browse files
committed
feat: document release process
Documented the release process for building and pushing the container image to the image registry.
1 parent 95b02fd commit bf495a5

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

Makefile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ endif
99
GIT_COMMIT_SHORT := $(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
1010

1111
# Container image configuration.
12-
IMAGE_REGISTRY ?= ghcr.io/oxidecomputer
12+
IMAGE_REGISTRY ?= localhost
1313
IMAGE_NAME ?= oxide-cloud-controller-manager
1414
IMAGE_TAG ?= $(patsubst v%,%,$(VERSION))-$(GIT_COMMIT_SHORT)
1515
IMAGE_FULL ?= $(if $(IMAGE_REGISTRY),$(IMAGE_REGISTRY)/)$(IMAGE_NAME):$(IMAGE_TAG)
@@ -21,7 +21,7 @@ test:
2121
--build-arg GO_CONTAINER_IMAGE=$(GO_CONTAINER_IMAGE) \
2222
--build-arg VERSION=$(VERSION) \
2323
--target builder \
24-
-t $(IMAGE_NAME)-builder:$(IMAGE_TAG) \
24+
-t $(if $(IMAGE_REGISTRY),$(IMAGE_REGISTRY)/)$(IMAGE_NAME)-builder:$(IMAGE_TAG) \
2525
.
2626
$(CONTAINER_RUNTIME) run --rm $(IMAGE_NAME)-builder:$(IMAGE_TAG) go test -v ./...
2727

@@ -31,6 +31,8 @@ build:
3131
$(CONTAINER_RUNTIME) build \
3232
--build-arg GO_CONTAINER_IMAGE=$(GO_CONTAINER_IMAGE) \
3333
--build-arg VERSION=$(VERSION) \
34+
--annotation org.opencontainers.image.description='Oxide Cloud Controller Manager' \
35+
--annotation org.opencontainers.image.source=https://github.com/oxidecomputer/oxide-cloud-controller-manager \
3436
-t $(IMAGE_FULL) \
3537
.
3638

README.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,23 @@ podman run \
102102
--cloud-provider oxide \
103103
--kubeconfig /tmp/kubeconfig.yaml
104104
----
105+
106+
== Release Process
107+
108+
The release process is manual and runs from a developer's workstation for now.
109+
110+
. Check out the revision to be released. Ensure the working copy is clean.
111+
112+
. Build the container image using the correct image registry and tag.
113+
+
114+
[source,shell]
115+
----
116+
IMAGE_REGISTRY=ghcr.io/oxidecomputer IMAGE_TAG=0.1.0 make build
117+
----
118+
119+
. Push the container image using to correct image registry.
120+
+
121+
[source,shell]
122+
----
123+
IMAGE_REGISTRY=ghcr.io/oxidecomputer IMAGE_TAG=0.1.0 make push
124+
----

0 commit comments

Comments
 (0)