summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordana <dana@dana.is>2022-04-02 18:36:43 -0500
committerdana <dana@dana.is>2022-04-02 18:38:34 -0500
commitcfce598a1313200928df2ac6ad8d848e06ebf27f (patch)
treee090b3fd44cf4bc1567c68b6917cd3eecf2a3c29
parent75410bc2a10cf6ce8282e02f15ddd3edb5d3121d (diff)
downloadzsh-cfce598a1313200928df2ac6ad8d848e06ebf27f.tar.gz
zsh-cfce598a1313200928df2ac6ad8d848e06ebf27f.zip
unposted: creating-a-release: Normalise white space, clarify some steps
(The need for these changes was discovered during the release of 5.8.1. Daniel suggested one. They were hinted at in security/107)
-rw-r--r--ChangeLog5
-rw-r--r--Etc/creating-a-release.txt34
2 files changed, 26 insertions, 13 deletions
diff --git a/ChangeLog b/ChangeLog
index e2c71b8b1..ff005651c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2022-04-02 dana <dana@dana.is>
+
+ * unposted (see security/107): Etc/creating-a-release.txt:
+ Normalise white space, clarify some steps
+
2022-04-01 Jun-ichi Takimoto <takimoto-j@kba.biglobe.ne.jp>
* 49943: Completion/Unix/Type/_time_zone: offer only filenames
diff --git a/Etc/creating-a-release.txt b/Etc/creating-a-release.txt
index 16784a054..640d19d39 100644
--- a/Etc/creating-a-release.txt
+++ b/Etc/creating-a-release.txt
@@ -7,9 +7,9 @@ To create a zsh release:
Config/version.mk to today's date
Config/version.mk version number
- Etc/FAQ.yo
- README
- NEWS
+ Etc/FAQ.yo ('latest version' section)
+ README (first two paragraphs, 'incompatibilities since' sections)
+ NEWS ('changes since' sections)
The version-number sequence is as follows:
@@ -31,7 +31,9 @@ To create a zsh release:
README should document compatibility-breaking changes. Generally, NEWS should
document new features and major bug fixes (but not routine fixes or changes to
- completion/contrib functions).
+ completion/contrib functions). Historically, these documents have often been
+ missed at the time the changes were actually committed, so it may be a good
+ idea to scan back through the history and fill in any blanks before release.
For -test releases, you may update the FAQ, README, etc., to refer to the
upcoming stable version number.
@@ -77,7 +79,7 @@ To create a zsh release:
- Create the keyring:
- cat web.git/Keys/*.asc > zsh-keyring.asc
+ cat web.git/Keys/*.asc > zsh-keyring.asc
- Upload to sf.net:
@@ -90,13 +92,13 @@ To create a zsh release:
You should upload five files:
- zsh-5.8.tar.xz
- zsh-5.8.tar.xz.asc
- zsh-doc-5.8.tar.xz
- zsh-doc-5.8.tar.xz.asc
- zsh-keyring.asc
+ zsh-5.8.tar.xz
+ zsh-5.8.tar.xz.asc
+ zsh-doc-5.8.tar.xz
+ zsh-doc-5.8.tar.xz.asc
+ zsh-keyring.asc
- (TODO: what about MD5SUM, FAQ, META-FAQ, all in www.zsh.org/pub/?)
+ (TODO: what about MD5SUM, FAQ, META-FAQ, all in www.zsh.org/pub/?)
Note that zsh-keyring.asc is fine to just overwrite, since it's only ever
appended to, and in any case the underlying Keys/*.asc files are in version
@@ -142,8 +144,14 @@ To create a zsh release:
# several minutes to appear afterwards
rsync ...
-- For stable releases, upload the build artefacts to zsh.org/pub; you may need
- assistance from another dev if you don't have access to do this.
+- For stable releases, upload the build artefacts to zsh.org/pub, making sure to
+ move the previous ones to old/. For example (assuming the new artefacts are in
+ the CWD):
+
+ mv /usr/local/www/ftp/pub/zsh-*.*(.) /usr/local/www/ftp/pub/old/
+ mv zsh-*.*(.) /usr/local/www/ftp/pub/
+
+ You may need assistance from another dev if you don't have access to do this.
- Post to -workers@