Check-in your release and the updated checksum files ''MD5SUMS'' and ''SHA1SUMS'' to

−

https://svn.xiph.org/releases/YOUR-COMPONENT/

−

Extending the checksum files is easy on a Unix machine:

−

md5sum YOUR-FILE >> MD5SUMS

−

sha1sum YOUR-FILE >> SHA1SUMS

−

= Website update =

+

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 version control ==

+

+

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:

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 ==

+

./autogen.sh

+

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.

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):

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 ====

+

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:

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 version control

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:

Git

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

./autogen.sh
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.

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):

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 news/press page. New news entries must be added seperately to the press page and the Xiph front page. Theora-related releases should also be added to the 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 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: