(I don't think we have any docs for the backport w...
# development
g
(I don't think we have any docs for the backport workflows at all; or am I blind?) I am blind: https://www.pantsbuild.org/prerelease/docs/contributions/development/maintenance-tasks-and-scripts#cherry-pick-a-pull-request-to-an-older-version. It doesn't mention the notes though, so above question stands.
f
I’ve just been checking out the cherry pick branch and manually committing the release notes change.
g
Yeah; I was just reading the source code for the bot
I guess figuring out where the notes should go would be quite hard.
OTOH I'm not sure how helpful those notes are on a cherry-pick... maybe cherry-picks should be no-notes by default. 🤷
b
My principle has been: release notes for a change should appear in only one file, which is the first .0 release that contains it. That means, something like: • if it's a cherrypick to a branch that's already had .0 released, then no notes at all • if it's a cherrypick to a branch that's still doing .0rcX releases, then that's where the notes should be (i.e. even in the PR to
main
) (As usual, just reminding that switching to towncrier-style release notes would simplify this: https://github.com/pantsbuild/pants/discussions/19247, if someone is willing to pick up the work 😅 )
g
Ok; so in this case we should have put it in 2.24.x and cherry-picked that into the notes on the branch. That makes sense. We've snafu'd this a bit then. It's inconsequential in the long run, but now we'll claim fixed twice for one PR.
(As it currently stands we're claiming fixed thrice - 2.23.1, 2.24.something, and 2.25.0.dev1)
b
hehe, triple whammy! As you say, I don't think it matters too much, so yeah, just keep rolling forward 🙂