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

Add more information to ironic-image release notes about changes in underlying Ironic changes #558

Open
tuminoid opened this issue Sep 10, 2024 · 5 comments
Assignees
Labels
kind/ci Categorizes issue or PR as related to CI or testing. kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue is ready to be actively worked on.

Comments

@tuminoid
Copy link
Member

Add more information to ironic-image release notes about changes in underlying Ironic changes. For example, diff between v26.0.0 and v26.0.1 show no changes, as we did no changes in the repository, but since we do not PIN the underlying Ironic branch to a commit, but follow a bugfix branch, it contained changes and the vulnerability fix.

This does not mean we should republish Ironic release notes, but at least link to the commit diff from previous tag in Ironic branch.

@metal3-io-bot metal3-io-bot added the needs-triage Indicates an issue lacks a `triage/foo` label and requires one. label Sep 10, 2024
@Rozzii
Copy link
Member

Rozzii commented Sep 11, 2024

/triage accepted
I don't think there is much to discuss about this the more info we can give the better.

@metal3-io-bot metal3-io-bot added triage/accepted Indicates an issue is ready to be actively worked on. and removed needs-triage Indicates an issue lacks a `triage/foo` label and requires one. labels Sep 11, 2024
@Rozzii
Copy link
Member

Rozzii commented Nov 6, 2024

For example adding a link to the ironic release notes:
https://docs.openstack.org/releasenotes/ironic/2024.1.html#relnotes-24-1-2-stable-2024-1

@tuminoid
Copy link
Member Author

tuminoid commented Nov 6, 2024

For example adding a link to the ironic release notes: https://docs.openstack.org/releasenotes/ironic/2024.1.html#relnotes-24-1-2-stable-2024-1

That, and possibly commit range diff URL. For bugfix branches if the release notes are not as clear or available in human readable form, then manual curation would be needed.

@elfosardo
Copy link
Member

I think it works the same for bugfix branches, just adding the diff when we do patch releases

@Rozzii Rozzii added this to the ironic-image - v27.0.0 milestone Nov 6, 2024
@Rozzii Rozzii added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. kind/documentation Categorizes issue or PR as related to documentation. kind/ci Categorizes issue or PR as related to CI or testing. labels Nov 7, 2024
iurygregory pushed a commit to iurygregory/ironic-image that referenced this issue Nov 12, 2024
[4.12] OCPBUGS-38513: set min version for python3-webob
@Rozzii
Copy link
Member

Rozzii commented Nov 27, 2024

The approach proposed here was followed in release 27 but the docs were not updated so this can't be closed.
I will move this to the next milestone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/ci Categorizes issue or PR as related to CI or testing. kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue is ready to be actively worked on.
Projects
Status: Backlog
Development

No branches or pull requests

4 participants