[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: The manual step in the minor branch creation workflow [1]

From: Nathan Hartman <hartman.nathan_at_gmail.com>
Date: Tue, 7 Apr 2020 11:11:39 -0400

On Thu, Mar 26, 2020 at 8:28 PM Daniel Shahaf <d.s_at_daniel.shahaf.name> wrote:
> Stefan, you asked on IRC:
>
> > [12:55] <stsp> [...] there's a step marked as "not automated" in https://subversion.apache.org/docs/community-guide/releasing.html#creating-branch
> >
> > [12:56] <stsp> but it seems the step (adding a branch entry to the backport conflict merge bot) has already happened
> >
> > [12:56] <stsp> has this been automated since? i used release.py for everything
> >
> > [12:56] <stsp> https://ci.apache.org/builders/svn-backport-conflicts-1.14.x
>
> You've confused two different bots.
>
> Setting up the conflicts bot, svn-backport-conflicts-1.14.x, _is_
> automated by release.py. HACKING says otherwise (in the antepenultimate
> bullet of [1]), but is out of date [2].

It seems that the text in #creating-branch is *not* actually out of
date. Rather, it's confusing because it reads as if the RM needs to
run release.py followed by all the steps under "Manual Steps."

It took me a while to realize that "Automated" or "Manual Steps" are
two alternatives available to the RM, that most of the "Manual Steps"
section describes steps that release.py automates, and that only the
final bullet in "Manual Steps" must be done manually, regardless
whether the RM opts for the Automated or Manual procedure.

So I propose the following change:

[[[

Index: docs/community-guide/releasing.part.html
===================================================================
--- docs/community-guide/releasing.part.html (revision 1876243)
+++ docs/community-guide/releasing.part.html (working copy)
@@ -1460,23 +1460,32 @@
 </h3>

 <p>Once people agree that a new release branch should be made, the
-Release Manager creates it with the following procedure (substitute
+Release Manager creates it with one of the following procedures (substitute
 A.B with the version you're preparing, eg. 1.3, or 2.0).</p>

-<h4>Automated</h4>
+<h4>Automated Procedure with release.py</h4>
+<p>Most of the work to create a release branch can be automated by
+tools/dist/release.py:</p>
 <p>Run this in an empty-ish directory where it will make some
temporary checkouts:</p>
 <pre>
 release.py --verbose create-release-branch A.B.0
 </pre>
-<p>Write a release notes template:</p>
+<p></p>
+<p>If not done previously, create the release notes template for the project
+website:</p>
 <pre>
 release.py --verbose write-release-notes A.B.0 &gt;
.../docs/release-notes/A.B.html
 svn add .../docs/release-notes/A.B.html
 svn ci -m "Add release notes template." .../docs/release-notes/A.B.html
 </pre>
-<div class="notice">Some steps are not automated&mdash;highlighted below.</div>
+<div class="notice">Some steps are not automated by release.py and must be
+done manually&mdash;skip to the end of the following section, where they are
+highlighted:</div>

-<h4>Manual Steps</h4>
+<h4>Manual Procedure</h4>
+<p>Most of the steps in this section can be automated by
+tools/dist/release.py&mdash;see above&mdash;but are documented here in case
+the Release Manager wants to do them manually:</p>
 <ul>
 <li><p>Create the new release branch with a server-side copy:</p>
     <pre>
@@ -1538,7 +1547,8 @@
        <tt>site/publish/docs/release-notes/A.B.html</tt></p></li>
 </ul>

-<div class="notice">The following steps are not automated:</div>
+<div class="notice">The following steps must be done manually, even when
+using release.py to automate most of the other steps:</div>
 <ul>
 <li>
     <p>Ask someone with appropriate access to add the A.B.x branch to the

]]]

Thoughts?

Nathan
Received on 2020-04-07 17:12:03 CEST

This is an archived mail posted to the Subversion Dev mailing list.