zsh-workers
 help / color / mirror / code / Atom feed
From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: [PATCH] New maintainer-facing documentation.
Date: Mon,  3 Sep 2018 17:54:50 +0000	[thread overview]
Message-ID: <20180903175450.30043-1-danielsh@tarpaulin.shahaf.local2> (raw)

---
 Etc/creating-a-release.txt | 60 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 Etc/creating-a-release.txt

diff --git a/Etc/creating-a-release.txt b/Etc/creating-a-release.txt
new file mode 100644
index 000000000..5d4e1e8b2
--- /dev/null
+++ b/Etc/creating-a-release.txt
@@ -0,0 +1,60 @@
+To create a zsh release:
+
+- Be satisfied that 'master' is releaseable.
+  (No recent destabilizing changes, `make check` passes, etc)
+
+- Bump or update:
+
+	Config/version.mk to today's date
+	Config/version.mk version number (sequence: 5.4.2, 5.4.2-dev-$((i++)), 5.4.2-test-$((++j)), 5.5)
+	Etc/FAQ.yo
+	README
+	NEWS
+
+- Commit those changes with an "unposted" ChangeLog entry.
+
+	git commit -am "Test release: 5.5.1-test-1." && 
+		zshdev-add-nnnnn-and-changelog unposted
+	# (Everyone has a different way of getting the "unposted" magic string
+	# into ChangeLog and the log message.  This script is how I do it; YMMV;
+	# see Etc/zsh-development-guide for alternative scripts.)
+
+- Create signed git tag named "zsh-5.5.1-..." (not "5.5.1-...")
+
+	git tag --sign -m "Tag version zsh-5.5.1-test-1." zsh-5.5.1-test-1
+
+- If the tagged release is a stable release (as opposed to a test release):
+
+	vi Config/version.mk # bump to 5.6-dev-0 and tomorrow's date
+	git commit -am "Post-release version bump." &&
+		zshdev-add-nnnnn-and-changelog unposted
+		# or local equivalent (see above)
+
+- Create tarball:
+
+	git checkout zsh-5.5.1-test-1
+	make -C Etc
+	make -C Doc everything
+	make tarxz-doc tarxz-src
+	for i in zsh*.tar.?z ; do gpg -ab -- $i ; done
+
+	# The tarxz-* targets create both *.tar.gz and *.tar.xz.
+
+- [one time step] Add your key to http://zsh.sf.net/Arc/source.html; see README in the 'web' repository for how to do this.  Its URL is:
+
+	git clone git://git.code.sf.net/p/zsh/web
+	git clone ssh://git.code.sf.net/p/zsh/web
+
+- Upload to sf.net
+
+	Test releases go to the "zsh-test" directory.
+	Stable releases to zsh/ and zsh-doc/.
+
+- Upload to zsh.org
+
+- Post to -workers@
+
+- After a day or so post to:
+
+	-users@, if test release;
+	-announce@, if stable release.


                 reply	other threads:[~2018-09-03 17:55 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180903175450.30043-1-danielsh@tarpaulin.shahaf.local2 \
    --to=d.s@daniel.shahaf.name \
    --cc=zsh-workers@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).