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.

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

📖 update releasing.md with links to main process #1266

Merged
merged 1 commit into from
May 8, 2023
Merged

📖 update releasing.md with links to main process #1266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ This document details the steps to create a release for

Things you should do before making a release:

- Check the
[Metal3 release process](https://github.com/metal3-io/metal3-docs/blob/main/processes/releasing.md)
for high-level process and possible follow-up actions
- Uplift controller Go modules to use latest corresponding CAPI modules
- Uplift any other direct/indirect dependency to close any public
vulnerabilities
Expand Down Expand Up @@ -57,8 +60,9 @@ We also need to create one or more tags for the Go modules ecosystem:

- For any subdirectory with `go.mod` in it (excluding `hack/tools`), create
another Git tag with directory prefix, ie.
`git tag -s -a api/v1.x.y -m api/v1.x.y`.
`git tag -s api/v0.x.y -m api/v0.x.y`.
For BMO, these directories are `api` and `pkg/hardwareutils`.
**NOTE**: Do not create annotated tags for go modules.

### Release artifacts

Expand Down Expand Up @@ -98,9 +102,4 @@ Next step is to clean up the release note manually.
Release process is complete, but further additional actions are required
in the Metal3 project to take in the new major/minor release. These steps are
documented in
[CAPM3 release process](https://github.com/metal3-io/cluster-api-provider-metal3/blob/main/docs/releasing.md)

## Announcements

We announce the release in Kubernetes slack on `#cluster-api-baremetal` channel
and through the `metal3-dev` group mailing list.
[Metal3 release process](https://github.com/metal3-io/metal3-docs/blob/main/processes/releasing.md)