Skip to content

Making a Release

rocky edited this page Aug 12, 2026 · 7 revisions

Table of Contents

Let people know of a pending release

Let people know on the libcdio-devel mailing list.

No major changes before release, please.

Coordinate with libcdio-paranoia release

... to be filled in

Get latest versions of config.status and config.guess

wget -O config.guess 'https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD'
wget -O config.sub 'https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD'

Set version

go over configure.ac, and remove .dev0 if necessary

  export LIBCDIO_VERSION=2.4.1 # or whatever it says in configure.ac
  export CDIO_VERSION_STR=${LIBCDIO_VERSION}.rc1
  echo $LIBCDIO_VERSION

Change LIBCDIO_VERSION_NUM in configure.ac:

LIBCDIO_VERSION_NUM=20201
AC_SUBST(LIBCDIO_VERSION_NUM)

Then:

 $ git checkout -b release-${CDIO_VERSION_STR}
 $ git commit -m"Get ready for release $CDIO_VERSION_STR" .

Check for ABI/API breakage

abi-dumper and abi-compliance-checker check ABI complance. pkgdiff internally uses .

Test

  • Test on lots of platforms; gcc compile farm, for example.
  • make distcheck should work.
  • Look for/fix/apply patches and outstanding bugs on Savannah GNU.

Update Release Notes (NEWS.md)

$ make ChangeLog`
$ codespell ChangeLog  # go over changes
$ cp ChangeLog ChangeLog-spell-corrected

Make spelling corrections. If there were some, then

$ mv ChangeLog.orig ChangeLog
$ diff -u ChangeLog ChangeLog-spell-corrected > ChangeLog-spell-corrected.diff
$ make ChangeLog # check that everything patches okay

To make changes without applying spelling patches:

make ChangeLog-without-spell-check
diff -u ChangeLog ChangeLog-spell-corrected > ChangeLog-spell-corrected.diff

Go over ChangeLog and add to NEWS.md. Update date of release.

Are sources up to date?

Make sure sources are current and checked in:

    $ git pull
    $ ./autogen.sh && make && make check

Update Documentation

Make doxygen documentation:

  $ (cd doc/doxygen; doxygen -u; ./run_doxygen)

Remove any errors.

Update release

On github

https://github.com/libcdio/libcdio/releases/new

 $ git pull --tags

Check github release

 $ pushd /tmp/
 $ wget https://github.com/rocky/libcdio/releases/download/release-${LIBCDIO_VERSION}/libcdio-${LIBCDIO_VERSION}.tar.bz2
 $ tar -xpf libcdio-paranoia-${LIBCDIO_VERSION}.tar.bz2
 $ cd libcdio-paranoia-${LIBCDIO_VERSION}
 $ ./configure && make && make check
 $ popd

For savannah

admin-tools contains gnupload and upload-to-ftp-gnu-org.sh scripts for getting to official ftp.gnu.org site. However getting the gpg verification check is currently broken again, and diagnostic information on this scant. So, for now, I have been skipping updating ftp.gnu.org

  • Make sure sources are current and checked in: git pull

  • copy doxygen html to web pages: cd ... (in savannah) libcdio-www/doxygen/libcdio rm .html cp /src/external-vcs/github/rocky/libcdio/doc/doxygen/html/.html .

    export CVS_RSH=ssh eval ssh-agent -c ssh-add appropriate-key

    cvs update .

    for each "U" html except libcdio.html that is put back, remove it with "rm" and then "cvs remove". For example, put in file /tmp/libcdio-remove.txt

     cvs remove `cat /tmp/libcdio-remove.txt`
    

    for each new "?" html add it. For example: put in file /tmp/libcdio-new.txt and run: cvs add cat /tmp/libcdio-new.txt

    cvs commit .

  • Bump version in configure.ac and add "git". See place above in removal. ...

Update documentation

Copy doxygen and html to web pages:

  $ cd ../libcdio-www/doxygen  # or whre
  $ rm *.html
  $ cp ../../libcdio/doc/doxygen/html/*.html .
  $ cvs update .

For each "U" html except libcdio.html that is put back, remove it with rm and then cvs remove. For example, put in file /tmp/libcdio-remove.txt.

$ rm `cat /tmp/libcdio-remove.txt`
$ cvs remove `cat /tmp/libcdio-remove.txt`

For each new "?" html add it. For example, put in file /tmp/libcdio-new.txt and run:

$ cvs add `cat libcdio/libcdio/tmp/cvs-update.txt`
$ cvs -m"Update for $LIBCDIO_VERSION release" commit .

copy libcdio manual to web page

     cd libcdio-www
     (cd ../libcdio/doc && make libcdio.html)
     cp ../libcdio/doc/libcdio.html .
     cvs commit -m"Update for $LIBCDIO_VERSION release" libcdio.html

Bump to git version

Bump the version in configure.ac and add "git". See the place above in removal.

Let libcdio-devel know of release

Again: libcdio-devel mailing list.