Skip to content

Commit b3c9e25

Browse files
committed
Update README.md with release steps
1 parent 02e14b5 commit b3c9e25

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

Diff for: README.md

+33
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,36 @@ CodeFlare Stack Compatibility Matrix
1010
| CodeFlare-SDK | v0.4.4 |
1111
| InstaScale | v0.0.4 |
1212
| KubeRay | v0.5.0 |
13+
14+
## Release process
15+
16+
Prerequisite:
17+
- Build and release [MCAD](https://github.com/project-codeflare/multi-cluster-app-dispatcher)
18+
- Build and release [InstaScale](https://github.com/project-codeflare/instascale)
19+
- Build and release [CodeFlare-SDK](https://github.com/project-codeflare/codeflare-sdk)
20+
21+
Release steps:
22+
1. Invoke [tag-and-build.yml](https://github.com/project-codeflare/codeflare-operator/actions/workflows/tag-and-build.yml) GitHub action, this action will create a repository tag, build and push operator image.
23+
24+
2. Check result of [tag-and-build.yml](https://github.com/project-codeflare/codeflare-operator/actions/workflows/tag-and-build.yml) GitHub action, it should pass.
25+
26+
3. Update CodeFlare Stack Compatibility Matrix in operator README.
27+
28+
4. Update InstaScale and MCAD versions:
29+
- in [Makefile](https://github.com/project-codeflare/codeflare-operator/blob/main/Makefile#L12-L16).
30+
- in [mcad/deployment.yaml.tmpl](https://github.com/project-codeflare/codeflare-operator/blob/main/config/internal/mcad/deployment.yaml.tmpl#L28)
31+
- in [controllers/defaults.go](https://github.com/project-codeflare/codeflare-operator/blob/main/controllers/defaults.go) by running `make defaults`
32+
- in [controllers/testdata/instascale_test_results/case_1/deployment.yaml](https://github.com/project-codeflare/codeflare-operator/blob/main/controllers/testdata/instascale_test_results/case_1/deployment.yaml) and [controllers/testdata/instascale_test_results/case_2/deployment.yaml](https://github.com/project-codeflare/codeflare-operator/blob/main/controllers/testdata/instascale_test_results/case_2/deployment.yaml)
33+
34+
5. Create a release in CodeFlare operator repository, release notes should include new support matrix.
35+
36+
6. Open a pull request to OpenShift community operators repository with latest bundle using make command, check that the created PR has proper content.
37+
```
38+
make openshift-community-operator-release
39+
```
40+
41+
7. Once merged, update component stable tags to point at the latest image release.
42+
43+
8. Announce the new release in slack and mail lists, if any.
44+
45+
9. Update the Distributed Workloads component in ODH.

0 commit comments

Comments
 (0)