How to do a release - Revision history

Conrad: /* Add new release files */ add svn propset info

2010-02-04T01:33:53Z

Add new release files: add svn propset info

← Older revision		Revision as of 01:33, 4 February 2010
Line 57:		Line 57:
	<tt>cd PROJECTNAME-releases</tt>		<tt>cd PROJECTNAME-releases</tt>
	<tt>svn add PROJECTNAME-x.x.x.tar.gz</tt>		<tt>svn add PROJECTNAME-x.x.x.tar.gz</tt>
		+
		+	Depending on your svn client, you may need to explicitly set the mime-type:
		+
		+	<tt>svn propset svn:mime-type application/octet-stream *.tar.gz</tt>

	Then, generate MD5 and SHA1 checksums for these files. Extending the checksum files is easy on a Unix machine:		Then, generate MD5 and SHA1 checksums for these files. Extending the checksum files is easy on a Unix machine:

Conrad: /* Tag in version control */ add info about tagging with git

2010-02-04T01:31:32Z

Tag in version control: add info about tagging with git

← Older revision		Revision as of 01:31, 4 February 2010
Line 8:		Line 8:
	Changes, additions, improvements, and major bugfixes should be summarized in the CHANGES file. A good way to avoid missing anything is to look through the SVN log since last release and cherrypick the bits that would be of interest to outside developers or project managers.		Changes, additions, improvements, and major bugfixes should be summarized in the CHANGES file. A good way to avoid missing anything is to look through the SVN log since last release and cherrypick the bits that would be of interest to outside developers or project managers.

-	== Tag in ~~SVN~~ ==	+	== Tag in version control ==

-	All official project releases must be tagged in ~~SVN~~. ~~This~~ is done using the SVN copy tag; essentially a versioned copy of a specific module/brach is copied to the tags directory in ~~SNV~~. For example, the libvorbis 1.2.2 release was tagged using:	+	All official project releases must be tagged in their version control system.
		+
		+	=== Subversion ===
		+
		+	Tagging is done using the SVN copy tag; essentially a versioned copy of a specific module/brach is copied to the tags directory in SVN. For example, the libvorbis 1.2.2 release was tagged using:

	svn copy http://svn.xiph.org/trunk/vorbis@16168 http://svn.xiph.org/tags/vorbis/libvorbis-1.2.2		svn copy http://svn.xiph.org/trunk/vorbis@16168 http://svn.xiph.org/tags/vorbis/libvorbis-1.2.2
		+
		+	=== Git ===
		+
		+	To create a tag called "1.0.0" for the commit at the HEAD of master:
		+
		+	git tag -a 1.0.0 master
		+
		+	You will be prompted to write a message describing the tag.
		+
		+	When you push your changes to git.xiph.org you must specify to also push tags; eg. for a remote named "xiph":
		+
		+	git push --tags xiph

	== Prepare a tarball ==		== Prepare a tarball ==

Ogg.k.ogg.k: mention make distcheck too

2009-06-30T10:55:08Z

mention make distcheck too

← Older revision		Revision as of 10:55, 30 June 2009
Line 17:		Line 17:
	./autogen.sh		./autogen.sh
	make dist		make dist
		+
		+	If a distcheck target is available, then it should be used instead, as it can spot
		+	common mistakes:
		+	./autogen.sh
		+	make distcheck

	Ideally, offer binaries for the different systems. This is not required, and many packages (such as libvorbis, etc) ship only as source releases. If in doubt, do what previous releases did. If there are no previous releases, libs usually ship as source only, applications tend to offer binaries.		Ideally, offer binaries for the different systems. This is not required, and many packages (such as libvorbis, etc) ship only as source releases. If in doubt, do what previous releases did. If there are no previous releases, libs usually ship as source only, applications tend to offer binaries.

Conrad: merge in text from ReleaseProcess

2009-06-30T08:23:33Z

merge in text from ReleaseProcess

← Older revision		Revision as of 08:23, 30 June 2009
Line 20:		Line 20:
	Ideally, offer binaries for the different systems. This is not required, and many packages (such as libvorbis, etc) ship only as source releases. If in doubt, do what previous releases did. If there are no previous releases, libs usually ship as source only, applications tend to offer binaries.		Ideally, offer binaries for the different systems. This is not required, and many packages (such as libvorbis, etc) ship only as source releases. If in doubt, do what previous releases did. If there are no previous releases, libs usually ship as source only, applications tend to offer binaries.

-	== ~~Repository check-in~~ ==	+	== Create a release directory under [http://svn.xiph.org/releases/ http://svn.xiph.org/releases/] ==
-	~~Check-in your release and~~ the ~~updated checksum files ''MD5SUMS'' and ''SHA1SUMS''~~ to	+
-	https://svn.xiph.org/releases/~~YOUR~~-~~COMPONENT~~/	+	If you are uploading the first release of a project to Xiph.org, then first create a release directory in the svn repository. You can do this using remote svn commands (rather than checking out the entire Xiph.org release archive):
-	Extending the checksum files is easy on a Unix machine:	+
-	md5sum ~~YOUR~~-~~FILE~~ >> MD5SUMS	+	<tt>svn mkdir https://svn.xiph.org/releases/PROJECTNAME</tt>
-	sha1sum ~~YOUR~~-~~FILE~~ >> SHA1SUMS	+
		+	Then check that directory out locally:
		+
		+	<tt>svn co https://svn.xiph.org/releases/PROJECTNAME PROJECTNAME-releases</tt>
		+
		+	== Add new release files ==
		+
		+	Add tarballs etc. to your local checkout of the release directory:
		+
		+	<tt>cd PROJECTNAME-releases</tt>
		+	<tt>svn add PROJECTNAME-x.x.x.tar.gz</tt>
		+
		+	Then, generate MD5 and SHA1 checksums for these files. Extending the checksum files is easy on a Unix machine:
		+
		+	<tt>md5sum PROJECTNAME-x.x.x.tar.gz >> MD5SUMS</tt>
		+	<tt>sha1sum PROJECTNAME-x.x.x.tar.gz >> SHA1SUMS</tt>
		+
		+	Check that the only modifications to the checksums are for the new files:
		+
		+	<tt>svn diff</tt>
		+
		+	If everything is ok (and the checksums for other files have not changed), commit:
		+
		+	<tt>svn commit</tt>

	== Website update ==		== Website update ==
Line 40:		Line 63:

	=== Update HTML ===		=== Update HTML ===
-	==== ~~Downloads page~~ ====	+
		+	==== Update [http://www.xiph.org/downloads/ http://www.xiph.org/downloads/] ====
		+
	Then you should update the [http://www.xiph.org/downloads/ download section] on the Xiph website.		Then you should update the [http://www.xiph.org/downloads/ download section] on the Xiph website.
-	~~In there repository this file~~ is ~~located at~~	+	The downloads page is in the normal svn repository for www.xiph.org:
-	https://svn.xiph.org/websites/xiph.org/downloads/~~index.shtml~~.en	+
		+	<tt>svn co https://svn.xiph.org/websites/xiph.org/downloads/</tt>
		+
		+	Update it with your release tarball name and checksum, and commit.

	==== News page ====		==== News page ====
Line 59:		Line 87:
	Announce your release where apropriate. This can include		Announce your release where apropriate. This can include
	* The various Xiph.Org website news pages; see above.		* The various Xiph.Org website news pages; see above.
-	* [http://lists.xiph.org/mailman/listinfo/announce Announce]	+	* The Xiph [http://lists.xiph.org/mailman/listinfo/announce Announce] mailing list
	* your blog		* your blog
	* the project's FreshMeat page		* the project's FreshMeat page
		+	* Linux Weekly News <lwn@lwn.net>
		+	* comp.os.linux.announce <cola@stump.algebra.com>
	* ''<other suitable places>''		* ''<other suitable places>''

Xiphmont: /* Tag in SVN */

2009-06-23T17:25:00Z

Tag in SVN

← Older revision		Revision as of 17:25, 23 June 2009
Line 9:		Line 9:

	== Tag in SVN ==		== Tag in SVN ==
		+
		+	All official project releases must be tagged in SVN. This is done using the SVN copy tag; essentially a versioned copy of a specific module/brach is copied to the tags directory in SNV. For example, the libvorbis 1.2.2 release was tagged using:
		+
		+	svn copy http://svn.xiph.org/trunk/vorbis@16168 http://svn.xiph.org/tags/vorbis/libvorbis-1.2.2

	== Prepare a tarball ==		== Prepare a tarball ==

Xiphmont: /* Update versions and CHANGES files */

2009-06-23T17:07:37Z

Update versions and CHANGES files

← Older revision		Revision as of 17:07, 23 June 2009
Line 3:		Line 3:

	== Update versions and CHANGES files ==		== Update versions and CHANGES files ==
		+
		+	Verify all project release versions embedded throughout the source and build system have been updated to appropriate values for the release. For projects that use the autotools, this means checking configure.in/configure.ac for AC_INIT, LIB_CURRENT, LIB_REVISION and *LIB_AGE. Depending on the project, there might be a version.h file, vendor or lib version strings embedded in the source somewhere (eg, lib/info.c for libvorbis or lib/internal.h for libtheora) and various other build project files for non-UNIX platforms (eg, macosx/Info.plist).
		+
		+	Changes, additions, improvements, and major bugfixes should be summarized in the CHANGES file. A good way to avoid missing anything is to look through the SVN log since last release and cherrypick the bits that would be of interest to outside developers or project managers.

	== Tag in SVN ==		== Tag in SVN ==

Xiphmont: Add sections for pre-tarball release prep

2009-06-23T16:56:54Z

Add sections for pre-tarball release prep

← Older revision		Revision as of 16:56, 23 June 2009
Line 1:		Line 1:
	You made a new release, the world is waiting for it.		You made a new release, the world is waiting for it.
	Here is what to do:		Here is what to do:
		+
		+	== Update versions and CHANGES files ==
		+
		+	== Tag in SVN ==

	== Prepare a tarball ==		== Prepare a tarball ==

Xiphmont: add 'news page updates' to list of announce locations

2009-06-23T16:55:42Z

add 'news page updates' to list of announce locations

← Older revision		Revision as of 16:55, 23 June 2009
Line 46:		Line 46:
	== Announcement ==		== Announcement ==
	Announce your release where apropriate. This can include		Announce your release where apropriate. This can include
		+	* The various Xiph.Org website news pages; see above.
	* [http://lists.xiph.org/mailman/listinfo/announce Announce]		* [http://lists.xiph.org/mailman/listinfo/announce Announce]
	* your blog		* your blog

Xiphmont: /* Website update */

2009-06-23T16:54:40Z

Website update

← Older revision		Revision as of 16:54, 23 June 2009
Line 16:		Line 16:

	== Website update ==		== Website update ==
		+	=== Add downloadable files ===
	After about 30(?) minutes repository changes will be visible on		After about 30(?) minutes repository changes will be visible on
	http://downloads.xiph.org/releases/YOUR-COMPONENT/		http://downloads.xiph.org/releases/YOUR-COMPONENT/
		+
		+	==== immediate mirror update ====
		+	The mirrorpush is performed by an every-half-hour cron task. If, for some reason, it's important to update the mirrors immediately, the following may be run as root on Motherfish to force-push:
		+
		+	cd /home/mirrorpush; ./update_downloads.sh
		+
		+	The script must be run from the /home/mirrorpush directory.
		+
		+	=== Update HTML ===
		+	==== Downloads page ====
	Then you should update the [http://www.xiph.org/downloads/ download section] on the Xiph website.		Then you should update the [http://www.xiph.org/downloads/ download section] on the Xiph website.
	In there repository this file is located at		In there repository this file is located at
	https://svn.xiph.org/websites/xiph.org/downloads/index.shtml.en		https://svn.xiph.org/websites/xiph.org/downloads/index.shtml.en
		+
		+	==== News page ====
		+	New releases of official projects should include an announcement. The same announcement that is sent to the email announcement lists is used as the basis for a 'press release' on the Xiph [http://www.xiph.org/press/index.shtml.en news/press page]. New news entries must be added seperately to the [http://www.xiph.org/press/index.shtml.en press page] and the [http://www.xiph.org/index.shtml.en Xiph front page]. Theora-related releases should also be added to the [http://www.theora.org/news/index.shtml.en Theora News page].
		+
		+	The various xiph.org web sites must be edited through SVN just like the release download files. The websites can be found under [https://svn.xiph.org/websites/ svn.xiph.org/websites/].
		+
		+	==== immediate HTML update ====
		+
		+	Website changes are updated by a cron script like the download mirrors. To force an immediate website update, perform the following as root on Motherfish:
		+
		+	cd /var/www; ./update_websites.sh

	== Announcement ==		== Announcement ==

Xiphmont: Elaborate on what to offer in a release

2009-06-23T16:31:45Z

Elaborate on what to offer in a release

← Older revision		Revision as of 16:31, 23 June 2009
Line 6:		Line 6:
	make dist		make dist

-	Ideally, offer binaries for the different systems.	+	Ideally, offer binaries for the different systems. This is not required, and many packages (such as libvorbis, etc) ship only as source releases. If in doubt, do what previous releases did. If there are no previous releases, libs usually ship as source only, applications tend to offer binaries.

	== Repository check-in ==		== Repository check-in ==