[ovs-dev] release-process: Describe how to branch and how to make a release.
diff mbox series

Message ID 20200215001850.3779818-1-blp@ovn.org
State New
Headers show
Series
  • [ovs-dev] release-process: Describe how to branch and how to make a release.
Related show

Commit Message

Ben Pfaff Feb. 15, 2020, 12:18 a.m. UTC
CC: Justin Pettit <jpettit@ovn.org>
Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 Documentation/internals/release-process.rst | 56 +++++++++++++++++++++
 1 file changed, 56 insertions(+)

Comments

0-day Robot Feb. 15, 2020, 12:59 a.m. UTC | #1
Bleep bloop.  Greetings Ben Pfaff, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line has non-spaces leading whitespace
#39 FILE: Documentation/internals/release-process.rst:144:
	git push origin HEAD:master HEAD^:refs/heads/branch-x.y

Lines checked: 81, Warnings: 1, Errors: 0


build:
mv tests/ovsdb-cluster-testsuite.tmp tests/ovsdb-cluster-testsuite
\
{ sed -n -e '/%AUTHORS%/q' -e p < ./debian/copyright.in;   \
  sed '34,/^$/d' ./AUTHORS.rst |			   \
	sed -n -e '/^$/q' -e 's/^/  /p';			   \
  sed -e '34,/%AUTHORS%/d' ./debian/copyright.in;	   \
} > debian/copyright
(printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n' && sed -e 's,[@]VERSION[@],2.13.90,g') < ./rhel/openvswitch-dkms.spec.in > openvswitch-dkms.spec.tmp || exit 1; if cmp -s openvswitch-dkms.spec.tmp rhel/openvswitch-dkms.spec; then touch rhel/openvswitch-dkms.spec; rm openvswitch-dkms.spec.tmp; else mv openvswitch-dkms.spec.tmp rhel/openvswitch-dkms.spec; fi
(printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n' && sed -e 's,[@]VERSION[@],2.13.90,g') < ./rhel/kmod-openvswitch-rhel6.spec.in > kmod-openvswitch-rhel6.spec.tmp || exit 1; if cmp -s kmod-openvswitch-rhel6.spec.tmp rhel/kmod-openvswitch-rhel6.spec; then touch rhel/kmod-openvswitch-rhel6.spec; rm kmod-openvswitch-rhel6.spec.tmp; else mv kmod-openvswitch-rhel6.spec.tmp rhel/kmod-openvswitch-rhel6.spec; fi
(printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n' && sed -e 's,[@]VERSION[@],2.13.90,g') < ./rhel/openvswitch-kmod-fedora.spec.in > openvswitch-kmod-fedora.spec.tmp || exit 1; if cmp -s openvswitch-kmod-fedora.spec.tmp rhel/openvswitch-kmod-fedora.spec; then touch rhel/openvswitch-kmod-fedora.spec; rm openvswitch-kmod-fedora.spec.tmp; else mv openvswitch-kmod-fedora.spec.tmp rhel/openvswitch-kmod-fedora.spec; fi
(printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n' && sed -e 's,[@]VERSION[@],2.13.90,g') < ./rhel/openvswitch.spec.in > openvswitch.spec.tmp || exit 1; if cmp -s openvswitch.spec.tmp rhel/openvswitch.spec; then touch rhel/openvswitch.spec; rm openvswitch.spec.tmp; else mv openvswitch.spec.tmp rhel/openvswitch.spec; fi
(printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n' && sed -e 's,[@]VERSION[@],2.13.90,g') < ./rhel/openvswitch-fedora.spec.in > openvswitch-fedora.spec.tmp || exit 1; if cmp -s openvswitch-fedora.spec.tmp rhel/openvswitch-fedora.spec; then touch rhel/openvswitch-fedora.spec; rm openvswitch-fedora.spec.tmp; else mv openvswitch-fedora.spec.tmp rhel/openvswitch-fedora.spec; fi
(printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n' && sed -e 's,[@]VERSION[@],2.13.90,g') \
	< ./xenserver/openvswitch-xen.spec.in > openvswitch-xen.spec.tmp || exit 1; \
if cmp -s openvswitch-xen.spec.tmp xenserver/openvswitch-xen.spec; then touch xenserver/openvswitch-xen.spec; rm openvswitch-xen.spec.tmp; else mv openvswitch-xen.spec.tmp xenserver/openvswitch-xen.spec; fi
make[3]: Entering directory `/var/lib/jenkins/jobs/upstream_build_from_pw/workspace/datapath'
make[3]: Leaving directory `/var/lib/jenkins/jobs/upstream_build_from_pw/workspace/datapath'
Documentation/internals/release-process.rst
See above for files that use tabs for indentation.
Please use spaces instead.
make[2]: *** [check-tabs] Error 1
make[2]: Leaving directory `/var/lib/jenkins/jobs/upstream_build_from_pw/workspace'
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/var/lib/jenkins/jobs/upstream_build_from_pw/workspace'
make: *** [all] Error 2


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
Ben Pfaff March 5, 2020, 8:32 p.m. UTC | #2
On Fri, Feb 14, 2020 at 04:18:50PM -0800, Ben Pfaff wrote:
> CC: Justin Pettit <jpettit@ovn.org>
> Signed-off-by: Ben Pfaff <blp@ovn.org>

This needs a review.
Justin Pettit March 6, 2020, 12:25 a.m. UTC | #3
Small point, but do you think it's worth pointing to the website repo in the instructions?  (I suppose anyone who's doing branching probably knows it.)

Acked-by: Justin Pettit <jpettit@ovn.org>

--Justin


> On Feb 14, 2020, at 4:18 PM, Ben Pfaff <blp@ovn.org> wrote:
> 
> CC: Justin Pettit <jpettit@ovn.org>
> Signed-off-by: Ben Pfaff <blp@ovn.org>
> ---
> Documentation/internals/release-process.rst | 56 +++++++++++++++++++++
> 1 file changed, 56 insertions(+)
> 
> diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
> index 89c11772489d..8912d7ef7aa1 100644
> --- a/Documentation/internals/release-process.rst
> +++ b/Documentation/internals/release-process.rst
> @@ -122,6 +122,62 @@ approximate:
> | T + 5.5       | Aug 15, Feb 15 | Release version x.y.0                |
> +---------------+----------------+--------------------------------------+
> 
> +How to Branch
> +-------------
> +
> +To branch "master" for the eventual release of OVS version x.y.0,
> +prepare two patches against master:
> +
> +1. "Prepare for x.y.0." following the model of commit 836d1973c56e
> +   ("Prepare for 2.11.0.").
> +
> +2. "Prepare for post-x.y.0 (x.y.90)." following the model of commit
> +   fe2870c574db ("Prepare for post-2.11.0 (2.11.90).")
> +
> +Post both patches to ovs-dev.  Get them reviewed in the usual way.
> +
> +Apply both patches to master, and create branch-x.y by pushing only
> +the first patch.  The following command illustrates how to do both of
> +these at once assuming the local repository HEAD points to the
> +"Prepare for post-x.y.0" commit:
> +
> +	git push origin HEAD:master HEAD^:refs/heads/branch-x.y
> +
> +Branching should be announced on ovs-dev.
> +
> +How to Release
> +--------------
> +
> +Follow these steps to release version x.y.z of OVS from branch-x.y.
> +
> +1. Prepare two patches against branch-x.y:
> +
> +   a. "Set release date for x.y.z".  For z = 0, follow the model of
> +      commit d11f4cbbfe05 ("Set release date for 2.12.0."); for z > 0,
> +      follow the model of commit 53d5c18118b0 ("Set release date for
> +      2.11.3.").
> +
> +   b. "Prepare for x.y.(z+1)." following the model of commit
> +      db02dd23e48a ("Prepare for 2.11.1.").
> +
> +3. Post the patches to ovs-dev.  Get them reviewed in the usual way.
> +
> +4. Apply the patches to branch-x.y.
> +
> +5. If z = 0, apply the first patch (only) to master.
> +
> +6. Sign a tag vx.y.z "Open vSwitch version x.y.z" and push it to the
> +   repo.
> +
> +7. Update http://www.openvswitch.org/download/.  See commit
> +   31eaa72cafac ("Add 2.12.0 and older release announcements.") in the
> +   website repo for an example.
> +
> +8. Consider updating the Wikipedia page for Open vSwitch at
> +   https://en.wikipedia.org/wiki/Open_vSwitch
> +
> +9. Tweet.
> +
> Contact
> -------
> 
> -- 
> 2.24.1
>
Ben Pfaff March 6, 2020, 7:42 p.m. UTC | #4
Can't hurt.  I added a pointer and applied this to master.  Thanks!

On Thu, Mar 05, 2020 at 04:25:40PM -0800, Justin Pettit wrote:
> Small point, but do you think it's worth pointing to the website repo in the instructions?  (I suppose anyone who's doing branching probably knows it.)
> 
> Acked-by: Justin Pettit <jpettit@ovn.org>
> 
> --Justin
> 
> 
> > On Feb 14, 2020, at 4:18 PM, Ben Pfaff <blp@ovn.org> wrote:
> > 
> > CC: Justin Pettit <jpettit@ovn.org>
> > Signed-off-by: Ben Pfaff <blp@ovn.org>
> > ---
> > Documentation/internals/release-process.rst | 56 +++++++++++++++++++++
> > 1 file changed, 56 insertions(+)
> > 
> > diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
> > index 89c11772489d..8912d7ef7aa1 100644
> > --- a/Documentation/internals/release-process.rst
> > +++ b/Documentation/internals/release-process.rst
> > @@ -122,6 +122,62 @@ approximate:
> > | T + 5.5       | Aug 15, Feb 15 | Release version x.y.0                |
> > +---------------+----------------+--------------------------------------+
> > 
> > +How to Branch
> > +-------------
> > +
> > +To branch "master" for the eventual release of OVS version x.y.0,
> > +prepare two patches against master:
> > +
> > +1. "Prepare for x.y.0." following the model of commit 836d1973c56e
> > +   ("Prepare for 2.11.0.").
> > +
> > +2. "Prepare for post-x.y.0 (x.y.90)." following the model of commit
> > +   fe2870c574db ("Prepare for post-2.11.0 (2.11.90).")
> > +
> > +Post both patches to ovs-dev.  Get them reviewed in the usual way.
> > +
> > +Apply both patches to master, and create branch-x.y by pushing only
> > +the first patch.  The following command illustrates how to do both of
> > +these at once assuming the local repository HEAD points to the
> > +"Prepare for post-x.y.0" commit:
> > +
> > +	git push origin HEAD:master HEAD^:refs/heads/branch-x.y
> > +
> > +Branching should be announced on ovs-dev.
> > +
> > +How to Release
> > +--------------
> > +
> > +Follow these steps to release version x.y.z of OVS from branch-x.y.
> > +
> > +1. Prepare two patches against branch-x.y:
> > +
> > +   a. "Set release date for x.y.z".  For z = 0, follow the model of
> > +      commit d11f4cbbfe05 ("Set release date for 2.12.0."); for z > 0,
> > +      follow the model of commit 53d5c18118b0 ("Set release date for
> > +      2.11.3.").
> > +
> > +   b. "Prepare for x.y.(z+1)." following the model of commit
> > +      db02dd23e48a ("Prepare for 2.11.1.").
> > +
> > +3. Post the patches to ovs-dev.  Get them reviewed in the usual way.
> > +
> > +4. Apply the patches to branch-x.y.
> > +
> > +5. If z = 0, apply the first patch (only) to master.
> > +
> > +6. Sign a tag vx.y.z "Open vSwitch version x.y.z" and push it to the
> > +   repo.
> > +
> > +7. Update http://www.openvswitch.org/download/.  See commit
> > +   31eaa72cafac ("Add 2.12.0 and older release announcements.") in the
> > +   website repo for an example.
> > +
> > +8. Consider updating the Wikipedia page for Open vSwitch at
> > +   https://en.wikipedia.org/wiki/Open_vSwitch
> > +
> > +9. Tweet.
> > +
> > Contact
> > -------
> > 
> > -- 
> > 2.24.1
> > 
>

Patch
diff mbox series

diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
index 89c11772489d..8912d7ef7aa1 100644
--- a/Documentation/internals/release-process.rst
+++ b/Documentation/internals/release-process.rst
@@ -122,6 +122,62 @@  approximate:
 | T + 5.5       | Aug 15, Feb 15 | Release version x.y.0                |
 +---------------+----------------+--------------------------------------+
 
+How to Branch
+-------------
+
+To branch "master" for the eventual release of OVS version x.y.0,
+prepare two patches against master:
+
+1. "Prepare for x.y.0." following the model of commit 836d1973c56e
+   ("Prepare for 2.11.0.").
+
+2. "Prepare for post-x.y.0 (x.y.90)." following the model of commit
+   fe2870c574db ("Prepare for post-2.11.0 (2.11.90).")
+
+Post both patches to ovs-dev.  Get them reviewed in the usual way.
+
+Apply both patches to master, and create branch-x.y by pushing only
+the first patch.  The following command illustrates how to do both of
+these at once assuming the local repository HEAD points to the
+"Prepare for post-x.y.0" commit:
+
+	git push origin HEAD:master HEAD^:refs/heads/branch-x.y
+
+Branching should be announced on ovs-dev.
+
+How to Release
+--------------
+
+Follow these steps to release version x.y.z of OVS from branch-x.y.
+
+1. Prepare two patches against branch-x.y:
+
+   a. "Set release date for x.y.z".  For z = 0, follow the model of
+      commit d11f4cbbfe05 ("Set release date for 2.12.0."); for z > 0,
+      follow the model of commit 53d5c18118b0 ("Set release date for
+      2.11.3.").
+
+   b. "Prepare for x.y.(z+1)." following the model of commit
+      db02dd23e48a ("Prepare for 2.11.1.").
+
+3. Post the patches to ovs-dev.  Get them reviewed in the usual way.
+
+4. Apply the patches to branch-x.y.
+
+5. If z = 0, apply the first patch (only) to master.
+
+6. Sign a tag vx.y.z "Open vSwitch version x.y.z" and push it to the
+   repo.
+
+7. Update http://www.openvswitch.org/download/.  See commit
+   31eaa72cafac ("Add 2.12.0 and older release announcements.") in the
+   website repo for an example.
+
+8. Consider updating the Wikipedia page for Open vSwitch at
+   https://en.wikipedia.org/wiki/Open_vSwitch
+
+9. Tweet.
+
 Contact
 -------