Skip to content

docs: correct the deploy and publish steps in RELEASE.md - #417

Open
TarikGul wants to merge 1 commit into
mainfrom
tg-releasemd-kargo
Open

TarikGul wants to merge 1 commit into
mainfrom
tg-releasemd-kargo

Conversation

@TarikGul

Copy link
Copy Markdown
Member

Description

Three things in RELEASE.md did not match how releasing actually works. All of them turned up while cutting v0.3.0.

Step 8 was the wrong task entirely. It said to open an issue in devops-cloud-infra, which predates the Kargo setup. The image tag is written by a Kargo promotion, so nothing in that repo pins a version and neither an issue nor a PR moves the deployment. The values-*.yaml files carry ingress, env and service config only. Rewritten to describe the promotion: the Kargo URL, that the Warehouse only matches the YYYYMMDD-HHMMSS-<sha8> tag so the semver tag is invisible to it, and that production stages source per chain from the matching westend stage, so promoting only westend-hub leaves the relay instances behind.

Step 7 credited the wrong trigger. It said creating the GitHub release publishes the Docker image. No workflow triggers on release creation; deploy.yml fires on the v* tag push from step 5. For v0.3.0 the image was on Docker Hub at 16:27 and the release was created at 16:34, so the release cannot have produced it. Now says what the tag push publishes, all three tags and which one Kargo consumes, and that the release is notes only.

Step 6 read as one clean sequence. cargo publish -p polkadot-rest-api --dry-run cannot resolve polkadot-rest-api-config until config is on the index, so it fails if you run it ahead of publishing config. Added a note so that failure is recognisable rather than alarming.

Also pointed the step 9 check at the six instances instead of a vague "all public instances up to date", using the same loop.

Verified

The verification loop in step 8 is the one I actually ran after promoting v0.3.0; all six instances report 0.3.0. The Kargo details come from kubernetes/polkadot-rest-api-kargo/templates/{warehouse,stage}.yaml and kubernetes/00-appset/values-products.yaml, and the URL from kubernetes/kargo/values-parity-mgmt.yaml and the SRE app deploy runbook.

Three things in RELEASE.md did not match how releasing actually works,
all found while cutting v0.3.0.

Step 8 said to open an issue in devops-cloud-infra. Deployment moved to
Kargo, the image tag is written by a promotion, and there is no version
pinned in that repo, so neither an issue nor a PR moves anything. It now
describes the promotion, including that the Warehouse only matches the
date stamped tag and that production stages source per chain from the
matching westend stage.

Step 7 said creating the GitHub release publishes the Docker image.
Nothing triggers on release creation. The v* tag push in step 5 does it,
which is why the image existed seven minutes before the v0.3.0 release
was created.

Step 6 presented the crates.io commands as one sequence. The server dry
run cannot resolve the config crate until config is published, so it
fails if run ahead of time.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant