Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: release process - add follow up section #1141

Merged
merged 7 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/config/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ packageversion
parameterization
pendingdeprecationwarning
pflag
pkgs
podinfo
podman
pre
Expand Down
48 changes: 36 additions & 12 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ created.
The release branches are initially created from the `main` branch via the GitHub
action [`Release Branch Creation`](./.github/workflows/release-branch.yaml).

A release is generated by calling a specific [
`release`](./.github/workflows/release.yaml) GitHub Action. It is
A release is generated by calling a specific
[`release`](./.github/workflows/release.yaml) GitHub Action. It is
executed on the branch which should be released - regardless whether it is a
patch or a minor release.

Expand Down Expand Up @@ -63,11 +63,11 @@ gitGraph TB:

### The Release Branch Creation / Cutoff

Every minor release starts with the creation of a release branch through [
`Release Branch Creation`](./.github/workflows/release-branch.yaml).
Every minor release starts with the creation of a release branch through
[`Release Branch Creation`](./.github/workflows/release-branch.yaml).

The version / minor of the release is based on the content of the file [
`VERSION`](./VERSION) which
The version / minor of the release is based on the content of the file
[`VERSION`](./VERSION) which
is updated automatically said `release` action. During development, the
content of this file is the complete release name of the release currently under
development and the suffix `-dev` (e.g. `0.1.0-dev`). The content of this file
Expand All @@ -93,8 +93,8 @@ This means that:
the release manager
- Any bug fix that is not deemed critical must be approved by the release
manager
- Any bug fix must first be merged to main and then [
`cherry-picked`](https://git-scm.com/docs/git-cherry-pick) to the release
- Any bug fix must first be merged to main and then
[`cherry-picked`](https://git-scm.com/docs/git-cherry-pick) to the release
branch.

At this point in time, any release targeted on this branch will have this minor
Expand Down Expand Up @@ -143,12 +143,12 @@ and after a grace period, promote the draft release to a full release.
This promotion is currently effectively a full rebuild from the release branch,
with the difference that the `-rc.<rc-number>` suffix is removed.

After the build, instead of finishing, the [
`release`](./.github/workflows/release.yaml) GitHub Action will also publish the
After the build, instead of finishing, the
[`release`](./.github/workflows/release.yaml) GitHub Action will also publish the
release.

This publishing to package registries (such as brew) is delegated to [
`publish-to-other-than-github`](./.github/workflows/publish-to-other-than-github.yaml)
This publishing to package registries (such as brew) is delegated to
[`publish-to-other-than-github`](./.github/workflows/publish-to-other-than-github.yaml)

After the official release on a release branch was successful, the version is considered `burned`.
This means that, even if bugs are found for that release in the future, a
Expand Down Expand Up @@ -244,3 +244,27 @@ branches were created on demand.
This model has now largely been replaced by the model we see in
this document. However you might still encounter leftovers form the old model
and you are encouraged to create issues regarding inconsistencies.

## Follow up actions
jakobmoellerdev marked this conversation as resolved.
Show resolved Hide resolved

Review and merge open pull requests.
frewilhelm marked this conversation as resolved.
Show resolved Hide resolved

### ocm-website

[Update the website](https://github.com/open-component-model/ocm-website/pulls).

### homebrew-tap

[Update brew tap](https://github.com/open-component-model/homebrew-tap/pulls).

### winget-pkgs

[Check winget-pkgs PRs for: `New version: Open-Component-Model.ocm-cli`](https://github.com/microsoft/winget-pkgs/pulls?q=is%3Apr+is%3Aopen+New+version%3A+Open-Component-Model.ocm-cli).

### chocolatey

[Check the `Packages in Moderation`](https://community.chocolatey.org/profiles/ocm.software#profile-moderation).

### piper-ocm-cli

[Update piper-ocm-cli](https://github.tools.sap/open-component-model/piper-ocm-cli/pulls).
Loading