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

Update README.md with release steps #118

Merged

Conversation

sutaakar
Copy link
Contributor

@sutaakar sutaakar commented Jun 1, 2023

Fixes #108

@openshift-ci
Copy link

openshift-ci bot commented Jun 1, 2023

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@sutaakar sutaakar marked this pull request as ready for review June 6, 2023 06:22
@sutaakar sutaakar force-pushed the release-instructions branch 2 times, most recently from c309529 to 9783861 Compare June 12, 2023 07:40
Copy link
Collaborator

@KPostOffice KPostOffice left a 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)

Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

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.
Copy link
Collaborator

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

https://github.com/marketplace/actions/create-release

Copy link
Contributor Author

@sutaakar sutaakar Jun 14, 2023

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.
Copy link
Collaborator

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right

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`
Copy link
Contributor

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.

Copy link
Contributor Author

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.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@sutaakar sutaakar force-pushed the release-instructions branch 3 times, most recently from 7edb431 to 7f0c189 Compare June 21, 2023 11:58
README.md Outdated

8. Announce the new release in slack and mail lists, if any.

9. Update the Distributed Workloads component in ODH.
Copy link
Member

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.

Copy link
Contributor Author

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

Copy link
Member

@anishasthana anishasthana left a 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?

Comment on lines +29 to +31
- 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`
Copy link
Collaborator

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?

Copy link
Contributor Author

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.

@openshift-ci openshift-ci bot added the lgtm label Jun 22, 2023
@openshift-ci
Copy link

openshift-ci bot commented Jun 22, 2023

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 9a7746b into project-codeflare:main Jun 22, 2023
@sutaakar sutaakar deleted the release-instructions branch June 22, 2023 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide release steps for Codeflare operator repository
5 participants