Skip to contentSkip to conversation

Process docs updates

PATCH In review Ian Jackson 2 participants 11 messages Nov 29, 2019

lore
Share & tools
lore
#0 lore raw

cover Process docs updates

I have a growing branch of patches to the release process docs. These should go into tree.

As the release technican I am going to commit these (to staging, which is the one we use for everything) unless someone clearly naks them. If you want to improve the process, patches to these files (etc.) are welcome but improvements should not block these documentation updates.

Ian Jackson (9):
branching checklist: drop some hg tag runes
branching checklist: Say perhaps no Config.mk changes needed branching checklist: More detailed instructions re MAINTAINERS release technician checklist: Reformat Config.mk changes release technician checklist: More explicit XEN_EXTRAVERSION docs/process: Fix minor error in formatting docs/process: Mention .Z-pre versions
docs/process: Notify release manager, rather than editing website docs/process: Move MAINTAINERS update for stable to .0 release

 docs/process/branching-checklist.txt          | 10 +---------
 docs/process/release-technician-checklist.txt | 26 ++++++++++++++++++++------
 2 files changed, 21 insertions(+), 15 deletions(-)
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#1 lore raw

PATCH 1/9 branching checklist: drop some hg tag runes

We no longer use hg

---
 docs/process/branching-checklist.txt | 4 ----
 1 file changed, 4 deletions(-)
docs/process/branching-checklist.txt +0 -4
index 5a02d21968..4cda33656d 100644
@@ -1,10 +1,6 @@
 v=4.1
 ov=4.0
 
-##* tag branchpoint
-##        hg tag $v.0-branched
-##        hg sign -k 'Xen tree' 4.1.0-branched
-
 * make branch in qemu-iwj.git
         git-branch $v-testing master
 
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#2 lore raw

PATCH 2/9 branching checklist: Say perhaps no Config.mk changes needed

In reply to Ian Jackson

It is only necessary to change Config.mk if it refers to unstable branches anywhere. This time, for example, it didn't.

---
 docs/process/branching-checklist.txt | 1 +
 1 file changed, 1 insertion(+)
docs/process/branching-checklist.txt +1 -0
index 4cda33656d..8437787446 100644
@@ -75,6 +75,7 @@ Ensure references to qemu trees in xen.git's Config.mk are updated.
 Check this with
         grep unstable Config.mk 
 which should produce no output.  Replace as necessary.
+(There may well be none.)
 
 Update newly diverging staging (unstable) according to
 release-technician-checklist.txt section re README etc.
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#3 lore raw

PATCH 3/9 branching checklist: More detailed instructions re MAINTAINERS

In reply to Ian Jackson

Provide a rune, following which a magit selective git add (or git add -p) can be used to commit the appropriate changes.

---
 docs/process/branching-checklist.txt | 2 ++
 1 file changed, 2 insertions(+)
docs/process/branching-checklist.txt +2 -0
index 8437787446..9e79f64157 100644
@@ -88,6 +88,8 @@ Update new stable tree's MAINTAINERS to contain correct info for this
 stable branch: usually, copy text from previous
 staging-$ov:MAINTAINERS section "Stable Release Maintenance"
 into new staging-$v, deleting what's there.
+  git cat-file blob origin/staging-$ov:MAINTAINERS >MAINTAINERS
+and review the changes, commiting ONLY THE RELEVANT ONES
 
 Set off a manual osstest run, since the osstest cr-for-branches change
 will take a while to take effect:
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#4 lore raw

PATCH 4/9 release technician checklist: Reformat Config.mk changes

In reply to Ian Jackson

One per line is a lot easier to read.

---
 docs/process/release-technician-checklist.txt | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
docs/process/release-technician-checklist.txt +4 -1
index 5dd85dbc40..ebf338c9d4 100644
@@ -49,7 +49,10 @@ t=RELEASE-$r
 * consider bumping sonames of shlibs
 
 * change xen-unstable README (should say "Xen 4.5" in releases and on stable branches, "Xen 4.5-unstable" on unstable)
-* change xen-unstable Config.mk (QEMU_UPSTREAM_REVISION, QEMU_TRADITIONAL_REVISION, MINIOS_UPSTREAM_REVISION)
+* change xen-unstable Config.mk
+#   QEMU_UPSTREAM_REVISION,
+#   QEMU_TRADITIONAL_REVISION
+#   MINIOS_UPSTREAM_REVISION
 * change SUPPORT.md heading version number; -unstable or -rc tag
 *     (empty in stable branches after .0 release).
 *     insert correct version number in release-notes link
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#5 lore raw

PATCH 5/9 release technician checklist: More explicit XEN_EXTRAVERSION

In reply to Ian Jackson

In particular, say clearly that X.Y-unstable should be thus, not X.Y.0-unstable.

---
 docs/process/release-technician-checklist.txt | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
docs/process/release-technician-checklist.txt +5 -1
index ebf338c9d4..f4bee4ee13 100644
@@ -59,7 +59,11 @@ t=RELEASE-$r
 * change xen-unstable xen/Makefile XEN_EXTRAVERSION
 # if main version number has changed (eg 4.7 -> 4.8) rerun ./autogen.sh
 * rerun ./autogen.sh to update version number in configure
-#    - XEN_EXTRAVERSION should be `.0-rc$(XEN_VENDORVERSION)'
+#    - XEN_EXTRAVERSION should be as follows
+#      `.0-rc$(XEN_VENDORVERSION)'       during freeze, first rc onwards (including staging, before branching)
+#      `-unstable$(XEN_VENDORVERSION)'   unstable aka unfrozen staging (or unstable branch, after branching)
+#      `.0$(XEN_VENDORVERSION)'          actual release of Xen X.Y.0 (aka first actual release of Xen X.Y)
+#      `.Z$(XEN_VENDORVERSION)'          actual release of Xen X.Y.Z (stable point realase)
 #
 #    - turn off debug on stable branches, if not already done
 #           - tools/Rules.mk
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Acked-by on v1 5/9
#6 lore raw

Re: [Xen-devel] [PATCH 5/9] release technician checklist: More explicit XEN_EXTRAVERSION

Quoted 5 lines · Ian Jackson

In particular, say clearly that X.Y-unstable should be thus, not X.Y.0-unstable.

Oh, I didn't even realize this wasn't written down anywhere. Thanks for making explicit.

Jan

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#7 lore raw

PATCH 6/9 docs/process: Fix minor error in formatting

In reply to Ian Jackson

The version number is not in the "heading".

---
 docs/process/release-technician-checklist.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/process/release-technician-checklist.txt +1 -1
index f4bee4ee13..72a4c36cd6 100644
@@ -55,7 +55,7 @@ t=RELEASE-$r
 #   MINIOS_UPSTREAM_REVISION
 * change SUPPORT.md heading version number; -unstable or -rc tag
 *     (empty in stable branches after .0 release).
-*     insert correct version number in release-notes link
+* SUPPORT.md: insert correct version number in release-notes link
 * change xen-unstable xen/Makefile XEN_EXTRAVERSION
 # if main version number has changed (eg 4.7 -> 4.8) rerun ./autogen.sh
 * rerun ./autogen.sh to update version number in configure
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#8 lore raw

PATCH 7/9 docs/process: Mention .Z-pre versions

In reply to Ian Jackson
---
 docs/process/release-technician-checklist.txt | 2 ++
 1 file changed, 2 insertions(+)
docs/process/release-technician-checklist.txt +2 -0
index 72a4c36cd6..5bce5ba63d 100644
@@ -64,6 +64,7 @@ t=RELEASE-$r
 #      `-unstable$(XEN_VENDORVERSION)'   unstable aka unfrozen staging (or unstable branch, after branching)
 #      `.0$(XEN_VENDORVERSION)'          actual release of Xen X.Y.0 (aka first actual release of Xen X.Y)
 #      `.Z$(XEN_VENDORVERSION)'          actual release of Xen X.Y.Z (stable point realase)
+#      `.Z-pre$(XEN_VENDORVERSION)'      stable branch, after release of Z-1
 #
 #    - turn off debug on stable branches, if not already done
 #           - tools/Rules.mk
@@ -145,6 +146,7 @@ RELEASE TARBALL
 	#   U oss-xen/release/4.8.0-rc2/xen-4.8.0-rc2.tar.gz
 	#   U oss-xen/release/4.8.0-rc2/xen-4.8.0-rc2.tar.gz.sig
 
+After a .0 release, update XEN_EXTRAVERSION again (to .1-pre, see above).
 
 update xenbits front page to change references to old stable branch
  into references to new stable branch
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#9 lore raw

PATCH 8/9 docs/process: Notify release manager, rather than editing website

In reply to Ian Jackson

The release technician has not been responsible for website updates for some time.

---
 docs/process/release-technician-checklist.txt | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
docs/process/release-technician-checklist.txt +1 -4
index 5bce5ba63d..59ee8bd3d2 100644
@@ -148,8 +148,5 @@ RELEASE TARBALL
 
 After a .0 release, update XEN_EXTRAVERSION again (to .1-pre, see above).
 
-update xenbits front page to change references to old stable branch
- into references to new stable branch
-
-Edit website
+Notify release manager of completion
 
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#10 lore raw

PATCH 9/9 docs/process: Move MAINTAINERS update for stable to .0 release

In reply to Ian Jackson

This should be done not while branching, but right after .0 is released.

---
 docs/process/branching-checklist.txt          | 7 -------
 docs/process/release-technician-checklist.txt | 8 ++++++++
 2 files changed, 8 insertions(+), 7 deletions(-)
docs/process/branching-checklist.txt +0 -7
index 9e79f64157..10c2038319 100644
@@ -84,13 +84,6 @@ Update newly diverging staging-$v according to
 release-technician-checklist.txt section re README etc.,
 including turning off debug.
 
-Update new stable tree's MAINTAINERS to contain correct info for this
-stable branch: usually, copy text from previous
-staging-$ov:MAINTAINERS section "Stable Release Maintenance"
-into new staging-$v, deleting what's there.
-  git cat-file blob origin/staging-$ov:MAINTAINERS >MAINTAINERS
-and review the changes, commiting ONLY THE RELEVANT ONES
-
 Set off a manual osstest run, since the osstest cr-for-branches change
 will take a while to take effect:
   ssh osstest.test-lab
docs/process/release-technician-checklist.txt +8 -0
index 59ee8bd3d2..7ed2636a12 100644
@@ -148,5 +148,13 @@ RELEASE TARBALL
 
 After a .0 release, update XEN_EXTRAVERSION again (to .1-pre, see above).
 
+After a .0 release,
+Update new stable tree's MAINTAINERS to contain correct info for this
+stable branch: usually, copy text from previous
+staging-$ov:MAINTAINERS section "Stable Release Maintenance"
+into new staging-$v, deleting what's there.
+  git cat-file blob origin/staging-$ov:MAINTAINERS >MAINTAINERS
+and review the changes, commiting ONLY THE RELEVANT ONES
+
 Notify release manager of completion
 
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel