[Xcb-commit] 3 commits - DevelopersGuide.mdwn ReleasingXcb.mdwn
Jamey Sharp
jamey at freedesktop.org
Wed Oct 29 16:30:44 PDT 2008
DevelopersGuide.mdwn | 17 +----------------
ReleasingXcb.mdwn | 47 ++++++++++++++++++++++++++++++-----------------
2 files changed, 31 insertions(+), 33 deletions(-)
New commits:
commit 1502023dbd0b5b5cd0c4907e370c9cc431c203e1
Author: Jamey Sharp <jamey at minilop.net>
Date: Wed Oct 29 16:30:17 2008 -0700
Unify the two different release checklists
Commit by Josh Triplett and Jamey Sharp
diff --git a/DevelopersGuide.mdwn b/DevelopersGuide.mdwn
index 9bf2aa1..3dcf968 100644
--- a/DevelopersGuide.mdwn
+++ b/DevelopersGuide.mdwn
@@ -86,20 +86,5 @@ The X core requests have been implemented in XCB, as well as the BIG-REQUESTS, X
### Making a release
-If you make a release of any component of xcb, the following steps are required.
-
-* bump the version number in configure.ac and commit the change.
-* check that **all** your changes are committed. *git-diff HEAD* must not show anything, *git status* must not show any uncommitted files.
-* *make distcheck* must succeed.
-* check that all your changes are pushed. *git log origin..* should not show anything
-* tag the release using *git tag -s -m "<msg>" <tag>*. Use *git-tag* to obtain the list of previous tags, and *git show <tag>* to see the full information about the tag.
-* copy the tarballs into the release directory (username at annarchy.freedesktop.org:/srv/xcb.freedesktop.org/www/dist)
-* push the tags using *git push --tags origin*
-* write the announce email
- * must include links to the new tarballs (e.g. http://xcb.freedesktop.org/dist/xcb-proto-1.0.0.tar.gz)
- * must include md5sum and a sha1sum of both tarballs
- * must include a git shortlog obtained by *git log <last tag>..<current tag> | git shortlog*
- * don't forget to sign the email.
-* send the announce email to xcb at lists.freedesktop.org, xorg-announce at lists.freedesktop.org, and xorg at lists.freedesktop.org
-
+See [[ReleasingXcb]].
diff --git a/ReleasingXcb.mdwn b/ReleasingXcb.mdwn
index c58967a..8b1a000 100644
--- a/ReleasingXcb.mdwn
+++ b/ReleasingXcb.mdwn
@@ -2,43 +2,52 @@
(based on cairo's release process) (requires the maintainer to have a gpg key to sign the tag)
-1. git-pull, no local changes (git diff HEAD is empty), master branch
-
1. Update README
1. Update NEWS
- - git-log --pretty=short <last version>.. | git-shortlog
+ - `git shortlog <last version>..`
- Skip any fixes to bugs that didn't exist in the last release
- Skip any typos or similar cosmetic changes
1. Bump the package version in the top-level configure.ac
-1. Commit changed README, NEWS, and configure.ac ("Release <name> <version>")
+1. Commit changed README, NEWS, and configure.ac ("Release <name> <version>")
+
+1. check that **all** your changes are committed.
+
+ - `git status` must not show any uncommitted files and you must be on the
+ `master` branch
+ - `git diff HEAD` must not show anything
-1. autoreconf -vfi && ./configure && make distcheck
+1. `autoreconf -vfi && ./configure && make distcheck`
-1. Tag the repository (git-tag -s -m "Release <name> <version>" <version>)
+1. Tag the repository
- - verify with git-verify-tag <version>
+ - `git tag -s -m "Release <name> <version>" <version>`
+ - verify with `git verify-tag <version>`
1. Compose the release mail (but don't send yet!)
- template off of last release mail
- replace version, README, NEWS
- git tag and keysign
- - MD5 & SHA1 checksums + URL's of tarballs (md5sum, sha1sum)
+ - MD5 and SHA1 checksums + URL's of tarballs (md5sum, sha1sum)
- note names of releasers
+ - don't forget to sign the email
-1. Push the tag and copy the .gz and .bz2 tarballs to xcb.freedesktop.org/dist
+1. Push the master branch and the tag with `git push origin master <version>`
- - git-push origin <version> && git-push origin
- - xcb.freedesktop.org:/srv/xcb.freedesktop.org/www/dist/
+1. Copy the .gz and .bz2 tarballs to
+ xcb.freedesktop.org:/srv/xcb.freedesktop.org/www/dist/ so they show up at
+ <http://xcb.freedesktop.org/dist/>.
1. Send the release mail to xorg and xcb lists
- - Subject: [ANNOUNCE] <name> <version>
+ - Subject: [ANNOUNCE] <name> <version>
+ - To: <xcb at lists.freedesktop.org>, <xorg-announce at lists.freedesktop.org>,
+ <xorg at lists.freedesktop.org>
1. Update the xcb wiki (main page, if necessary)
-1. Bug Jamey to release a Debian package
+1. Bug Jamey Sharp and/or Julien Danjou to release a Debian package
commit 00037da7db2a802f45f8bb511ce360363aa20529
Author: Jamey Sharp <jamey at minilop.net>
Date: Wed Oct 29 16:11:00 2008 -0700
Let ikiwiki/markdown number the steps in the release checklist.
Commit by Josh Triplett and Jamey Sharp.
diff --git a/ReleasingXcb.mdwn b/ReleasingXcb.mdwn
index ad4936b..c58967a 100644
--- a/ReleasingXcb.mdwn
+++ b/ReleasingXcb.mdwn
@@ -4,25 +4,25 @@
1. git-pull, no local changes (git diff HEAD is empty), master branch
-2. Update README
+1. Update README
-3. Update NEWS
+1. Update NEWS
- git-log --pretty=short <last version>.. | git-shortlog
- Skip any fixes to bugs that didn't exist in the last release
- Skip any typos or similar cosmetic changes
-4. Bump the package version in the top-level configure.ac
+1. Bump the package version in the top-level configure.ac
-5. Commit changed README, NEWS, and configure.ac ("Release <name> <version>")
+1. Commit changed README, NEWS, and configure.ac ("Release <name> <version>")
-6. autoreconf -vfi && ./configure && make distcheck
+1. autoreconf -vfi && ./configure && make distcheck
-7. Tag the repository (git-tag -s -m "Release <name> <version>" <version>)
+1. Tag the repository (git-tag -s -m "Release <name> <version>" <version>)
- verify with git-verify-tag <version>
-8. Compose the release mail (but don't send yet!)
+1. Compose the release mail (but don't send yet!)
- template off of last release mail
- replace version, README, NEWS
@@ -30,15 +30,15 @@
- MD5 & SHA1 checksums + URL's of tarballs (md5sum, sha1sum)
- note names of releasers
-9. Push the tag and copy the .gz and .bz2 tarballs to xcb.freedesktop.org/dist
+1. Push the tag and copy the .gz and .bz2 tarballs to xcb.freedesktop.org/dist
- git-push origin <version> && git-push origin
- xcb.freedesktop.org:/srv/xcb.freedesktop.org/www/dist/
-10. Send the release mail to xorg and xcb lists
+1. Send the release mail to xorg and xcb lists
- Subject: [ANNOUNCE] <name> <version>
-11. Update the xcb wiki (main page, if necessary)
+1. Update the xcb wiki (main page, if necessary)
-12. Bug Jamey to release a Debian package
+1. Bug Jamey to release a Debian package
commit a754853c9f54eef9210c8f6b1615d99f4b91e6e3
Author: Jamey Sharp <jamey at minilop.net>
Date: Wed Oct 29 16:10:05 2008 -0700
Expand release process documentation
Commit by Josh Triplett and Jamey Sharp
diff --git a/ReleasingXcb.mdwn b/ReleasingXcb.mdwn
index 9998447..ad4936b 100644
--- a/ReleasingXcb.mdwn
+++ b/ReleasingXcb.mdwn
@@ -4,9 +4,13 @@
1. git-pull, no local changes (git diff HEAD is empty), master branch
-2. README (if not already present)
+2. Update README
-3. NEWS (hint: use git-log --pretty=short <last version>.. | git-shortlog)
+3. Update NEWS
+
+ - git-log --pretty=short <last version>.. | git-shortlog
+ - Skip any fixes to bugs that didn't exist in the last release
+ - Skip any typos or similar cosmetic changes
4. Bump the package version in the top-level configure.ac
More information about the xcb-commit
mailing list