https://pantsbuild.org/ logo
Join Slack
Powered by
I finished revamping the release docs! Feedback ap...
# announce
h
I finished revamping the release docs! Feedback appreciated 🙂 https://pants.readme.io/docs/release-process The main changes: 1. The release series gets set up in 
dev0
, not 
rc0
, so that we can remove 
master.rst
. 2. Merges the release prep steps into one list, rather than 
master branch
vs. 
stable branch
. 3. Mentions checking for deprecations 4. Explains how to prep the changelog 5. Describes the process for cherry-picking in RCs 6. Adds sample language for emails
@polite-garden-50641 +1 to your proposal to better automate changelog prep. This paragraph is very unsatisfaying..
Use your best judgment when classifying commits. If you are uncertain, you can either message the author on Slack or, in your PR, add a comment for the entry to ask for input from others.
p
I would say... let's just start by adding the labels to the repo and asking committers (which is mostly you @witty-crayon-22786 & @hundreds-breakfast-49010 this days) to associate those labels to every PR before it is merged, it should be ok to have multiple labels.
here is the list of labels I suggested:
Copy code
release:API-Changes
release:Testing
release:Documentation
release:Refactoring
release:Features
release:Bugfixes
đź‘Ť 2
and maybe "release:version" for the PR we use to release (i.e. "prepare for release XXXX")
h
Agreed, and then a next step would be updating 
release-changelog-helper.sh
to automatically consume that.
and maybe “release:version” for the PR we use to release
We currently use milestones for this, but we only have one milestone for each major release, like 
1.28.x
. I’m not sure how we’d want to approach this here
p
After that, I can take a stab at updating the script that generates the change log to use those PRs (probably later this week or this weekend).
I remember you mentioning asking the pants committers about adding a branch protection rule (via GH action) that will require those on PRs... how did that go ?
h
I remember you mentioning asking the pants committers about adding a branch protection rule
I never got around to doing it, tbh. I’ll email now though, as this coincides with a change to no longer using 
master.rst
I don’t think we need to worry about labeling the version, actually. The script 
release-changelog-helper.sh
asks you to specify the starting commit, and then uses HEAD for the ending commit. It should probably keep doing that It would be tricky to label the version because we have changes that land in master, but need to get cherry-picked.
Cool, just sent the email. Thanks for advocating for this, Asher!
w
not sure what to suggest instead, but it’s not clear in https://pants.readme.io/docs/release-process#1-prepare-the-changelog that notes edits happen in master and must be cherry-picked to the release branch.
h
I’ll reword. The cherry-pick should be covered by 5b in that section, though
w
yea. it’s just a challenging step in general, because you have to prep notes in the release branch, but then land them in master.
h
Right. I’ll add a 
warning
to call extra attention, actually
w
confusing. thanks!
h
Okay reload the page
w
thanks.
❤️ 1
another bit of general feedback might be to have a standardized sub-heading for “dev/rc/rc0 only” type stuff
but yea, thanks for doing that. will likely suggest more edits next time i have to run through it.
h
I tried to standardize it, but yeah might be a better way. Cool, thanks for taking a look! That’s one of my favorite benefits of the site - there’s now very little friction to updating it
w
i’ll miss codereviews a bit, but yea… hopefully adhoc edits are easier.
đź‘Ť 1
Open in Slack
PreviousNext
Powered by