Maintenance note

This page describes some everyday tasks that Texdoc maintainers should do.

Releasing a new version

Checking all aliases in the distributed texdoc.cnf

This operation should be executed using the latest version of TeX Live.

rake check_aliases

Checking the search results

Executing rake save_output to save some featured results into the output dir. Then you can compare the results with the output of the previous versions by using the diff utility.

Updating NEWS

The brief summary of the changes made in the release should be documented in NEWS.

To make a release

First, bump the version:

NEW_TEXDOC_VERSION=<new version>
rake bump_version -- $NEW_TEXDOC_VERSION
git add -A
git commit -m "bump version to $NEW_TEXDOC_VERSION"
git tag v$NEW_TEXDOC_VERSION
git push
git push --tags

Then, make an archive for CTAN:

rake ctan