Skip to content

feat(docs): add a RELEASE.md file#81

Open
cratelyn wants to merge 1 commit intomainfrom
kate/release-docs
Open

feat(docs): add a RELEASE.md file#81
cratelyn wants to merge 1 commit intomainfrom
kate/release-docs

Conversation

@cratelyn
Copy link
Member

the release process for this repository was not documented.

this commit introduces a small release runbook.

Signed-off-by: katelyn martin git@katelyn.world

the release process for this repository was not documented.

this commit introduces a small release runbook.

Signed-off-by: katelyn martin <git@katelyn.world>
@cratelyn cratelyn self-assigned this Feb 19, 2026
@cratelyn cratelyn marked this pull request as ready for review February 19, 2026 16:22
@cratelyn
Copy link
Member Author

this is missing some steps.

i'm not sure what though, so i'll need some help from someone that does know what the release process for this repository is.

@olix0r
Copy link
Member

olix0r commented Feb 19, 2026

The dev release process is fairly involved and manual currently. It typically works as follows:

1. In dev

  • Create a branch in dev git co -b $(whoami)/v49
  • First, update versions (i.e. with go run ./update-versions.go --in-place)
  • just push=false version=v49 build -- build images
  • just push=true version=v49 build -- push images -- note this publishes dev images
  • In dev: replace all references to v48 with v49 -- especially in actions/setup-tools
  • Ensure proper versions in actions/setup-go and actions/setup-rust
  • git push origin $(whoami)/v49 -- so that you can reference the branch from other repos

2. In linkerd2-proxy (etc)

  • Create a branch in that repo.

  • Update devcontainer.json to use the new version, boot up the devcontainer and ensure your normal workflow continues working.

  • Update all references to dev container images and actions. Update actions to reference the SHA of the dev branch during testing.

  • Push a draft PR

  • Repeat for all other repos.

    • Iterate as needed, publishing dev images and actions updates as needed.

3. In dev

  • Merge PR that bumps versions.
  • Publish a tag/release off of main once it is merged.

4. In other repos

  • replace the SHA with the release tag
  • move PRs out of draft
  • merge

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.

2 participants

Comments