diff options
Diffstat (limited to 'Etc/creating-a-release.txt')
| -rw-r--r-- | Etc/creating-a-release.txt | 43 |
1 files changed, 37 insertions, 6 deletions
diff --git a/Etc/creating-a-release.txt b/Etc/creating-a-release.txt index 805ff2ce0..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. @@ -72,6 +74,13 @@ To create a zsh release: git clone git://git.code.sf.net/p/zsh/web git clone ssh://git.code.sf.net/p/zsh/web +- [one time step] Add your key to the Keys/ directory in the 'web' repository, using + `gpg --armor --export $YourPublicKeyFingerprint`. + +- Create the keyring: + + cat web.git/Keys/*.asc > zsh-keyring.asc + - Upload to sf.net: Test releases go to the "zsh-test" directory. @@ -81,6 +90,22 @@ To create a zsh release: [Select All] next to "Default Download For:". This should cause sf.net to offer that artifact in the "Looking for the latest version?" line. + 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 + + (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 + control. + + TODO: link to zsh-keyring.asc from Arc/source.html and elsewhere + - If the new release is a stable release, update zsh.sf.net: # Move into the 'web' repository mentioned above @@ -119,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@ |