Skip to content

✨ Add a new release workflow and documentation #211

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 5 commits into from
Jun 16, 2025
Merged

✨ Add a new release workflow and documentation #211

merged 5 commits into from
Jun 16, 2025

Conversation

dtantsur
Copy link
Member

Closes: #119
Signed-off-by: Dmitry Tantsur dtantsur@protonmail.com

@metal3-io-bot
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

@metal3-io-bot metal3-io-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 27, 2025
@metal3-io-bot metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 27, 2025
@elfosardo
Copy link
Member

/cc @elfosardo

@metal3-io-bot metal3-io-bot requested a review from elfosardo March 27, 2025 13:47
tuminoid
tuminoid reviewed Mar 27, 2025
View reviewed changes
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.

This document is grabbing the old release workflow. We have new automated workflow for releasing in use in CAPM3/IPAM/BMO.

Take the document from IPAM or CAPM3. If this was from BMO main, then it means we've forgot to update the documentation there. We'll do that soon for the 0.10 release cycle.

dtantsur added 2 commits June 12, 2025 14:26
@dtantsur
Add releasing documentation
4e7053f 
Closes: metal3-io#119
Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
@dtantsur
Update to the new releasing workflow
2a22660 
Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
@metal3-io-bot metal3-io-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 12, 2025
@dtantsur dtantsur changed the title 📖 Add releasing documentation ✨ Add a new release workflow and documentation Jun 12, 2025
@dtantsur dtantsur marked this pull request as ready for review June 12, 2025 13:09
@metal3-io-bot metal3-io-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 12, 2025
@dtantsur dtantsur requested a review from tuminoid June 12, 2025 13:09
@dtantsur
Change the guidance on the branch preparation commit
7c9e55b 
Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
@elfosardo
Copy link
Member

/approve

@metal3-io-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: elfosardo

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

@metal3-io-bot metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 12, 2025
tuminoid
tuminoid reviewed Jun 13, 2025
View reviewed changes
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.

  • Checked the workflow the best I could, it should be fine.
  • Makefile has one cleanup suggestion.
  • Release note generation is working fine.
  • Documentation has some changes needed, and some future items just noted down

I will create IRSO branch 0.4 yaml job in project-infra and we can link it as prior art right away here. I'll link the PR soon.

@tuminoid
Copy link
Member

/hold

@metal3-io-bot metal3-io-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 13, 2025
@tuminoid tuminoid mentioned this pull request Jun 13, 2025
Merged
tuminoid
tuminoid reviewed Jun 13, 2025
View reviewed changes
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.

Some milestone related comments added.

@tuminoid tuminoid mentioned this pull request Jun 13, 2025
Merged
@tuminoid
Copy link
Member

metal3-io/metal3-docs#550 is updating the general releasing document. I'm not including moving more stuff there now, just updating it to match what we do now, new prior art, removal of mariadb etc. It will fail until this PR is merged as it links to this releasing.md

PTAL if I missed something.

Rozzii
Rozzii reviewed Jun 16, 2025
View reviewed changes
Copy link
Member

@Rozzii Rozzii left a comment

Choose a reason for hiding this comment

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

Two additional comments, otherwise looks good apart from Tuomo's comments.

@dtantsur
Modernize the releasing documentation
b7c9021 
Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
@dtantsur dtantsur requested review from tuminoid and Rozzii June 16, 2025 14:20
@dtantsur
Remove the not-yet-exisiting link
febe248 
Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
@dtantsur
Copy link
Member Author

IrSO is broken by metal3-io/utility-images#32, I think we can merge this anyway.

@tuminoid
Copy link
Member

IrSO is broken by metal3-io/utility-images#32, I think we can merge this anyway.

Merged.

/retest

tuminoid
tuminoid reviewed Jun 16, 2025
View reviewed changes
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.

/lgtm
/unhold

This should work fine. If not, we'll patch in another PR.

@metal3-io-bot metal3-io-bot added lgtm Indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 16, 2025
@tuminoid
Copy link
Member

/retest

Rozzii
Rozzii reviewed Jun 16, 2025
View reviewed changes
Copy link
Member

@Rozzii Rozzii left a comment

Choose a reason for hiding this comment

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

/lgtm

@metal3-io-bot metal3-io-bot merged commit bb8bc9c into metal3-io:main Jun 16, 2025
17 of 21 checks passed
@dtantsur dtantsur deleted the releasing branch June 17, 2025 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tuminoid tuminoid tuminoid left review comments

@Rozzii Rozzii Rozzii left review comments

@lentzi90 lentzi90 Awaiting requested review from lentzi90

@elfosardo elfosardo Awaiting requested review from elfosardo

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the releasing process
5 participants
@dtantsur @metal3-io-bot @elfosardo @tuminoid @Rozzii