Skip to content

Commit 25670e0

Browse files
authored
Update README.md with release steps
1 parent d03836b commit 25670e0

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

Diff for: README.md

+45
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
11
# codeflare-operator
22
Operator for installation and lifecycle management of CodeFlare distributed workload stack, starting with MCAD and InstaScale
3+
4+
5+
## Release process
6+
7+
Prerequisite:
8+
- Build and release [MCAD](https://github.com/project-codeflare/multi-cluster-app-dispatcher)
9+
10+
Release steps:
11+
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.
12+
13+
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.
14+
15+
3. Prepare bundle files:
16+
```
17+
make bundle
18+
```
19+
20+
4. Copy CRDs from the MCAD:
21+
```
22+
make sync-crd
23+
```
24+
25+
> **Note**
26+
> The `make sync-crd` will be removed in future and Kustomize will take care of retrieving MCAD CRDs, see https://github.com/project-codeflare/codeflare-operator/pull/116
27+
28+
29+
5. Build and push bundle image:
30+
```
31+
make bundle-build
32+
make bundle-push
33+
```
34+
35+
6. Update support matrix in operator README. **TBD**
36+
37+
7. Update release notes of operator version to include new support matrix. **TBD**
38+
39+
8. Open a pull request to OpenShift community operators repository with latest bundle.
40+
> **Note**
41+
> Should be automated by https://github.com/project-codeflare/codeflare-operator/issues/97
42+
43+
9. Once merged, update component stable tags to point at the latest image release.
44+
45+
10. Announce the new release in slack and mail lists, if any.
46+
47+
11. Update the Distributed Workloads component in ODH.

0 commit comments

Comments
 (0)