Skip to content

Update documentation for release process #2223

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 22, 2025
Merged

Update documentation for release process #2223

merged 1 commit into from
May 22, 2025

Conversation

kishen-v
Copy link
Contributor

@kishen-v kishen-v commented Feb 26, 2025 •
edited
Loading

What this PR does / why we need it:
This PR captures additional information associated with the release-process.

Special notes for your reviewer:
This is a initial set of steps identified for the release process. Please let me know if any section needs elaboration.

/area provider/ibmcloud

Release note:

Update documentation for release process

@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. area/provider/ibmcloud Issues or PRs related to ibmcloud provider labels Feb 26, 2025
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 26, 2025
@kishen-v
Copy link
Contributor Author

cc @Prajyot-Parab
/kind documentation

@netlify Netlify
Copy link

netlify bot commented Feb 26, 2025 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

Name Link
🔨 Latest commit 1d4745f
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-cluster-api-ibmcloud/deploys/682d9d2d45548a0008966ba3
😎 Deploy Preview https://deploy-preview-2223.cluster-api-ibmcloud.sigs.k8s.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 26, 2025
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 11, 2025
@Amulyam24
Copy link
Contributor

@kishen-v, any update on this?

@kishen-v
Copy link
Contributor Author

Hey @Amulyam24 and @Karthik-K-N,
We are planning to add more details into this PR, and looking forward to capturing more information in the next release to make it a complete guide..

We may need to hold this for a bit to add in more information.

Thanks!

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 29, 2025
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 13, 2025
@kishen-v kishen-v force-pushed the update-docs branch 2 times, most recently from 5f8313b to d54f385 Compare May 13, 2025 13:36
@kishen-v kishen-v marked this pull request as ready for review May 13, 2025 13:37
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 13, 2025
@k8s-ci-robot k8s-ci-robot requested a review from mkumatag May 13, 2025 13:37
@kishen-v
Copy link
Contributor Author

Hey @Prajyot-Parab @Amulyam24 @Karthik-K-N,
PTAL when time permits, the PR is now ready for review.

@kishen-v kishen-v changed the title Update initial release process documentation Update documentation for release process May 13, 2025
@kishen-v
Copy link
Contributor Author

/test pull-cluster-api-provider-ibmcloud-test

Karthik-K-N
Karthik-K-N reviewed May 13, 2025
View reviewed changes
Copy link
Contributor

@Karthik-K-N Karthik-K-N left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, @Amulyam24 and @Prajyot-Parab would be the right folks for review.

Amulyam24
Amulyam24 reviewed May 19, 2025
View reviewed changes
docs/book/src/developer/release.md Outdated
Comment on lines 37 to 38
- The status of the build jobs can be tracked from : https://prow.k8s.io/?job=post-cluster-api-provider-ibmcloud-push-images
- The built images are available here: https://console.cloud.google.com/gcr/images/k8s-staging-capi-ibmcloud/
Copy link
Contributor

Choose a reason for hiding this comment

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

The links do not appear as a hyperlink in the doc - https://deploy-preview-2223.cluster-api-ibmcloud.sigs.k8s.io/developer/release

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 see that's the case with other links too. For eg:
https://deploy-preview-2223.cluster-api-ibmcloud.sigs.k8s.io/topics/vpc/uploading-an-image.html?highlight=https#add-vm-image-to-vpc

Should we consider taking it up in a separate issue?

Copy link
Contributor

Choose a reason for hiding this comment

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

sure, we can fix the hyperlinks as a separate issue.

Copy link
Contributor Author

@kishen-v kishen-v May 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Looks like the above link is the only one that's not linked as such, I'll add the suggestion to this PR

Raised a separate PR for the same issue related to the above link that's not hyperlinked.
#2365

@kishen-v kishen-v mentioned this pull request May 20, 2025
Merged
@kishen-v
Copy link
Contributor Author

cc @Prajyot-Parab

@Prajyot-Parab
Copy link
Contributor

@kishen-v update release note in PR description.

@kishen-v
Copy link
Contributor Author

Hey @Prajyot-Parab, I've updated the release notes section, thanks!

@Prajyot-Parab Prajyot-Parab requested a review from Amulyam24 May 21, 2025 08:52
Prajyot-Parab
Prajyot-Parab reviewed May 21, 2025
View reviewed changes
Copy link
Contributor

@Prajyot-Parab Prajyot-Parab left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 21, 2025
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 21, 2025
Amulyam24
Amulyam24 approved these changes May 22, 2025
View reviewed changes
Copy link
Contributor

@Amulyam24 Amulyam24 left a comment

Choose a reason for hiding this comment

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

/lgtm

Thanks @kishen-v!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 22, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Amulyam24, kishen-v, Prajyot-Parab

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 22, 2025
@k8s-ci-robot k8s-ci-robot merged commit a27efe3 into kubernetes-sigs:main May 22, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Karthik-K-N Karthik-K-N Karthik-K-N left review comments

@Amulyam24 Amulyam24 Amulyam24 approved these changes

@Prajyot-Parab Prajyot-Parab Prajyot-Parab approved these changes

@mkumatag mkumatag Awaiting requested review from mkumatag

Assignees

@Amulyam24 Amulyam24

@Prajyot-Parab Prajyot-Parab

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/provider/ibmcloud Issues or PRs related to ibmcloud provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kishen-v @k8s-ci-robot @Amulyam24 @Prajyot-Parab @Karthik-K-N