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: Update release process #307

Merged
merged 23 commits into from
Feb 22, 2023

Conversation

ckadner
Copy link
Member

@ckadner ckadner commented Jan 11, 2023

Proposed Changes

Elaborate the steps in the release process.

https://github.com/ckadner/modelmesh-serving/blob/update-release-process-doc/docs/release-process.md

Updates since last review:

  • how to create a new modelmesh-minio-examples image
    • create a new repo for it
  • add a new section before the release
    • update KServe Go dependency using the latest KServe release candidate and test it
    • update the CRDs (config/crd/bases)
  • a new section on what happens after a release was published:

Signed-off-by: Christian Kadner <[email protected]>
@ckadner ckadner marked this pull request as draft January 11, 2023 01:02
@ckadner ckadner self-assigned this Jan 11, 2023
@ckadner ckadner added the documentation Improvements or additions to documentation label Jan 11, 2023
@ckadner ckadner changed the title Update RELEASE_PROCESS.md docs: Update RELEASE_PROCESS.md Jan 11, 2023
@ckadner ckadner changed the title docs: Update RELEASE_PROCESS.md docs: Update RELEASE_PROCESS.md Jan 11, 2023
@ckadner ckadner marked this pull request as ready for review January 11, 2023 04:51
@ckadner ckadner assigned njhill and unassigned ckadner Jan 11, 2023
Copy link
Member

@njhill njhill left a comment

Choose a reason for hiding this comment

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

Thanks @ckadner these look really good. Just had a couple of minor comments

1. They simplify back porting critical bug fixes to a patch level release for a particular release stream (e.g., producing a `v0.6.1` from `release-0.6`), when appropriate.
1. They allow a release wrangler or other developers to focus on a release without interrupting development on `main`,
2. They allow developers to track the development of a release before a release candidate is declared,
3. They simplify back porting critical bug fixes to a patch level release for a particular release stream (e.g., producing a `v0.6.1` from `release-0.6`), when appropriate.
Copy link
Member

Choose a reason for hiding this comment

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

nit: Any reason for changing the numbering here (same applies to below)?

Copy link
Member Author

Choose a reason for hiding this comment

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

you mean we should use 0.10 as an example or how we utilize Mardown numbering here?

release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
11. Compare the release and release artifacts to those of previous releases to make
sure nothing was missed. Verify that the newly released version of the
[`modelmesh-controller`](https://hub.docker.com/r/kserve/modelmesh-controller/tags)
was pushed to DockerHub.
Copy link
Member

Choose a reason for hiding this comment

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

Should we mention anything about testing / checking fvt results?

Copy link
Member Author

Choose a reason for hiding this comment

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

yup -- my running list:

  • FVT, test -- verify the "check" results on last pushed tag
  • update KServe ... website, charts (more details to be gathered)
  • work with Dan on a relase blog

Copy link
Member

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

Just leaving a few proofreading-related comments! Thanks Christian.

release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
release/RELEASE_PROCESS.md Outdated Show resolved Hide resolved
Signed-off-by: Christian Kadner <[email protected]>
@ckadner ckadner self-assigned this Feb 16, 2023
Signed-off-by: Christian Kadner <[email protected]>
@kserve kserve deleted a comment from kserve-oss-bot Feb 16, 2023
@ckadner ckadner marked this pull request as ready for review February 16, 2023 06:22
@ckadner ckadner requested review from njhill and rafvasq February 16, 2023 06:22
@kserve kserve deleted a comment from kserve-oss-bot Feb 16, 2023
@ckadner ckadner changed the title docs: Update RELEASE_PROCESS.md docs: Update release process Feb 16, 2023
@ckadner
Copy link
Member Author

ckadner commented Feb 17, 2023

Thanks for your review @rafvasq -- I addressed your comments and added the post-release section including the step about working with Dan on a release blog. If you have further guidance on that, please advice :-)

Signed-off-by: Christian Kadner <[email protected]>
Signed-off-by: Christian Kadner <[email protected]>
Signed-off-by: Christian Kadner <[email protected]>
Copy link
Member

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

Thanks Christian, just a few nits and a question about where FVTs fits in to all of this.

Re: the release blog and collaboration with Dan, I think you captured it fine. I ended up simply providing the ModelMesh portion of the blog to him via a review.

action to push the respective (pre-)release container images to DockerHub which
are needed in the next step.

2. Verify image tags got pushed to [DockerHub](https://hub.docker.com/u/kserve):
Copy link
Member

Choose a reason for hiding this comment

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

nit: "were pushed"


## Release Blog

If possible work with [Dan Sun](https://kubeflow.slack.com/archives/D04PVPHMN8K)
Copy link
Member

Choose a reason for hiding this comment

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

nit: "If possible, work with" (comma)


## Update the KServe Website

In the `kserve/website` repository update all reference to the previous ModelMesh
Copy link
Member

Choose a reason for hiding this comment

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

nit: "In the kserve/website repository, update" (comma)

docs/release-process.md Outdated Show resolved Hide resolved
docs/release-process.md Show resolved Hide resolved
Signed-off-by: Christian Kadner <[email protected]>
@ckadner
Copy link
Member Author

ckadner commented Feb 17, 2023

Thank you for your detailed review @rafvasq -- I pushed another update addressing your comments

Copy link
Member

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

Thanks @ckadner, I left a link to v.10's blog but think there are enough examples and linking to the PR draft like you did is helpful too. Up to you if you want to include it too. Otherwise LGTM :)

- [v0.7.0](https://kserve.github.io/website/blog/articles/2021-10-11-KServe-0.7-release)
- [v0.8.0](https://kserve.github.io/website/0.8/blog/articles/2022-02-18-KServe-0.8-release/#modelmesh-updates)
- [v0.9.0](https://kserve.github.io/website/0.9/blog/articles/2022-07-21-KServe-0.9-release/#inferenceservice-api-for-modelmesh)
- [v0.10.0 draft](https://github.com/kserve/website/pull/227#discussion_r1098917277)
Copy link
Member

Choose a reason for hiding this comment

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

FYI, v0.10's blog has now been released.

@njhill
Copy link
Member

njhill commented Feb 22, 2023

Thanks @ckadner!

@njhill
Copy link
Member

njhill commented Feb 22, 2023

/lgtm

@kserve-oss-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ckadner, njhill, rafvasq

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

@kserve-oss-bot kserve-oss-bot merged commit bf412be into kserve:main Feb 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved documentation Improvements or additions to documentation lgtm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants