-
Notifications
You must be signed in to change notification settings - Fork 43
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
Update README.md with release steps #118
Update README.md with release steps #118
Conversation
Skipping CI for Draft Pull Request. |
25670e0
to
f1de0b4
Compare
c309529
to
9783861
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small fix I think
- Build and release [MCAD](https://github.com/project-codeflare/multi-cluster-app-dispatcher) | ||
- Build and release [InstaScale](https://github.com/project-codeflare/instascale) | ||
- Build and release [CodeFlare-SDK](https://github.com/project-codeflare/codeflare-sdk) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there's a step missing here which is something along the lines of updating the values of MCAD and InstaScale where necessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, I haven't found any direct dependency on MCAD or InstaScale code apart from an image declaration in https://github.com/project-codeflare/codeflare-operator/blob/main/controllers/defaults.go .
I mentioned these repositories as prerequisites because I consider operator as a "main" repo, handling other components, so to build it as last.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 13 in 3180604
INSTASCALE_VERSION ?= v0.0.4 |
This value needs to be updated and the new defaults file must be generated if we are targeting a new release of InstaScale with the new CodeFlare operator release. The MCAD_VERSION variable will also need to be updated once @astefanutti 's PR with an MCAD version/custom image support is merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KPostOffice readme adjusted to contain also version changes in files across repository.
README.md
Outdated
|
||
3. Update CodeFlare Stack Compatibility Matrix in operator README. | ||
|
||
4. Create a release in CodeFlare operator repository, release notes should include new support matrix. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possible future work is adding these steps to the existing GitHub action
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, there is also a GitHub CLI for such action: gh release create ${{ github.event.inputs.tag }} --generate-notes
README.md
Outdated
|
||
4. Create a release in CodeFlare operator repository, release notes should include new support matrix. | ||
|
||
5. Open a pull request to OpenShift community operators repository with latest bundle using make command, check that the created PR has proper content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also possible future work here. Create another GitHub action which opens PR to OpenShift community operator and updates tag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right
9783861
to
4883a55
Compare
080b417
to
df6c833
Compare
df6c833
to
fb92ac6
Compare
fb92ac6
to
b3c9e25
Compare
4. Update InstaScale and MCAD versions: | ||
- in [Makefile](https://github.com/project-codeflare/codeflare-operator/blob/main/Makefile#L12-L16). | ||
- in [mcad/deployment.yaml.tmpl](https://github.com/project-codeflare/codeflare-operator/blob/main/config/internal/mcad/deployment.yaml.tmpl#L28) | ||
- in [controllers/defaults.go](https://github.com/project-codeflare/codeflare-operator/blob/main/controllers/defaults.go) by running `make defaults` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think that's needed, as it's done when running make build
as part of the release workflow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mention it here because the change needs to be merged, so it is good to merge it together with other version changes in one commit.
7edb431
to
7f0c189
Compare
README.md
Outdated
|
||
8. Announce the new release in slack and mail lists, if any. | ||
|
||
9. Update the Distributed Workloads component in ODH. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As part of this, we will need to copy over / update the compatibilty matrix in the distributed workloads repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a note about updating compatibility matrix
7f0c189
to
35bd873
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good to me. @KPostOffice @astefanutti can you give it another look as well?
- in [Makefile](https://github.com/project-codeflare/codeflare-operator/blob/02e14b535b4f7172b0b809bcae4025008a1a968b/Makefile#L12-L16). | ||
- in [mcad/deployment.yaml.tmpl](https://github.com/project-codeflare/codeflare-operator/blob/main/config/internal/mcad/deployment.yaml.tmpl#L28) | ||
- in [controllers/defaults.go](https://github.com/project-codeflare/codeflare-operator/blob/main/controllers/defaults.go) by running `make defaults` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that this should be the first step shouldn't it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't have to be, the Tag and Release
GitHub action anyway replace this value when building the image.
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: KPostOffice The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Fixes #108