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

🌱 Issue template for preparing new minor release #686

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adilGhaffarDev
Copy link
Member

What this PR does / why we need it:
This PR is adding an issue template to prepare a new minor release. It will make it easier to create tracking issue.

Signed-off-by: Muhammad Adil Ghaffar <muhammad.adil.ghaffar@est.tech>
@metal3-io-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sunnatillo for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@metal3-io-bot metal3-io-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 12, 2024
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

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

Also, add a step in docs/releasing.md about using this issue template.

## Tasks
* [ ] Uplift CAPI to latest minor in IPAM, also check migration guide:[Migration guide for providers](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/migrations). [Prior art ](https://github.com/metal3-io/ip-address-manager/pull/497).
IMPORTANT: Always read migration guide and make sure to do the changes accordingly in CAPM3 and IPAM.
* [ ] Verify all go modules are matching with hack/verify-release.sh script.
Copy link
Member

Choose a reason for hiding this comment

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

Not just go modules, but all issues reported by it.

* The following is based on the v1.7 minor release. Modify according to the tracked minor release.

## Tasks
* [ ] Uplift CAPI to latest minor in IPAM, also check migration guide:[Migration guide for providers](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/migrations). [Prior art ](https://github.com/metal3-io/ip-address-manager/pull/497).
Copy link
Member

Choose a reason for hiding this comment

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

Can we wrap this at 80

title: Prepare for v<release-tag>
---

Please see this documentation for more details about release process: https://github.com/metal3-io/metal3-docs/blob/main/processes/releasing.md
Copy link
Member

Choose a reason for hiding this comment

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

Don't use bare links. Also wrap 80.

* [ ] Uplift CAPI to latest minor in IPAM, also check migration guide:[Migration guide for providers](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/migrations). [Prior art ](https://github.com/metal3-io/ip-address-manager/pull/497).
IMPORTANT: Always read migration guide and make sure to do the changes accordingly in CAPM3 and IPAM.
* [ ] Verify all go modules are matching with hack/verify-release.sh script.
* [ ] Release IPAM (Branch out, add branch protection and required tests, also check new image is created in quay).
Copy link
Member

Choose a reason for hiding this comment

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

We have documentation for this, so rather than listing just some items, maybe link the doc instead, or list all the things needed to do. Promote use of verify-release.sh for post release checks too.

Copy link
Member

Choose a reason for hiding this comment

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

As this is issue template, I would lean towards listing all the things that needs to be done. It will give clear view of release process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants