- Git clone git@github.com:translate/pootle.git pootle-release
- Create release notes
- Up version number
- Update translations
- make build
- Test install and other tests
- Tag the release
- Publish on PyPI
- Upload to Sourceforge
- Add product version to Bugzilla
- Release documentation
- Update translate website
- Unstage sourceforge
- Announce to the world
- Cleanup
We need to check and document these if needed:
- Pre-release checks
- Translations
- Build docs: we need to check if e need to build the docs for the release
- Change URLs to point to the correct docs: do we want to change URLs to point to the $version docs rather then 'latest'
- Building on Windows, building for other Linux distros. We have produced
- Communicating to upstream packagers
We work from a clean checkout to esnure that everything you are adding to the build is what is in VC and doesn't contain any of your uncommitted changes. It also ensure that someone else could relicate your process.
git clone git@github.com:translate/pootle.git pootle-release
The release notes will be used in these places:
- Pootle website - download page (used in gh-pages)
- Sourceforge download - README.rst (used to give user info)
- Email announcements - text version
We create our release notes in reStructured Text, since we use that elsewhere and since it can be rendered well in some of our key sites.
First we need to create a log of changes in Pootle:
git diff N-1 HEAD > release/RELEASE-NOTES-$version.rst
Edit this file. You can use the commits as a guide to build up the release notes. You should remove all log messages before the release.
Note
Since the release notes will be used in places that allow linking we use links within the notes. These should link back to products websites (Virtaal, Pootle, etc), references to Translate and possibly bug numbers, etc.
Read for grammar and spelling errors.
Note
When writing the notes please remember:
- The voice is active. 'Translate has released a new version of the toolkit', not 'A new version of the toolkit was release by Translate'.
- The connection to the users is human not distant.
- We speak in familiar terms e.g. "I know you've been waiting for this release" instead of formal.
Update the version number in:
pootle/__version__.py
docs/conf.py`
In __version__.py
, bump the build number if anybody used the toolkit with
the previous number, and there have been any changes to code touching stats or
quality checks. An increased build number will force a toolkit user, like
Pootle, to regenerate the stats and checks.
For conf.py
change version
and release
Note
FIXME - We might want to automate the version and release info so that we can update it in one place.
The version string should follow the pattern:
$MAJOR-$MINOR-$MICRO[-$EXTRA]
E.g.
1.10.0 0.9.1-rc1
$EXTRA
is optional but all the three others are required. The first
release of a $MINOR
version will always have a $MICRO
of .0
. So
1.10.0
and never just 1.10
.
Update the translations from the Pootle server
Download all translations:
# On pootle.locamotion.org ./manage.py sync_stores --project=pootle # On your computer scp -rp $user@pootle.locamotion.org/$location pootle/locales
Update
pootle/locale/LINGUAS
to list the languages we would like to ship. While we package all PO files, this is an indication of which ones we want packagers to use. The requirements is roughly 100% translated with no obvious variable errors.
Building is the first step to testing that things work. From your clean checkout run:
make mo-all # if we are shipping an pre-release make build
This will create a tarball in dist/
which you can use for further testing.
Note
We use a clean checkout just to make sure that no inadvertant changes make it into the release.
The easiest way to test is in a virtualenv. You can install the new toolkit using:
pip install path/to/dist/Pootle-$version.tar.bz2
This will allow you test installation of the software.
You can then proceed with other tests such as checking
- Documentation is available
- Converters and scripts are installed and run correctly
- Meta information about the package is correct. See pypi section of reviewing meta data.
You should only tag once you are happy with your release as there are some things that we can't undo.
git tag -a 2.5.0 -m "Tag version 2.5.0" git push --tags
Publish the package on the Python Package Index (PyPI)
Note
You need a username and password on https://pypi.python.org and have rights to the project before you can proceed with this step.
These can be stored in $HOME/.pypirc
and will contain your username and
password. A first run of ./setup.py register
will create such a file.
It will also actually publish the meta-data so only do it when you are
actually ready.
Review the meta data. This is stored in setup.py
, use ./setup.py --help
to se some options to display meta-data. The actual long description is taken
from /README.rst
.
To test before publishing run:
make test-publish-pypi
Then to actually publish:
make publish-pypi
Publishing files to the Translate Sourceforge project.
Note
You need to have release permissions on sourceforge to perform this step.
You will need:
- Tarball of the release
- Release notes in reStructured Text
- Create a new folder in the Pootle
release folder using the 'Add Folder' button. The folder must have the same
as the release name e.g.
2.5.0-rc1
. Mark this as being for staging for the moment. make publish-sourceforge
will give you the command to upload your tarball andREADME.rst
.- Upload tarball for release.
- Upload release notes as
README.rst
. - Click on the info icon for
README.rst
and tick "Exclude Stats" to exlude the README from stats counting.
- Check that the README.rst for the parent
Pootle
folder is still appropriate, this is the text from/README.rst
. - Check all links for
README.rst
files, new release and parent.
We need to allow users to report issues against the released version.
In the Administration interface, products add a product version.
We need a tagged release before we can do this. The docs are published on Read The Docs.
Use the admin pages to flag a version that should be published
Note
FIXME we might need to do this before publishing so that we can update doc references to point to the tagged version as apposed to the latest version.
We use github pages for the website. First we need to checkout the pages:
git checkout gh-pages
- In
_posts/
add a new release posting. This is in Markdown format (for now), so we need to change the release notes .rst to .md, which mostly means changing URL links from '`xxx <link>`_
' to[xxx](link)
. - Change $version as needed. See
download.html
,_config.yml
andegrep -r $old_release *
git commit
andgit push
- changes are quite quick so easy to review.
If you have created a staged release folder, then unstage it now.
Let people know that there is a new version:
- Announce on mailing lists: Send the announcement to the translate-announce mailing lists on translate-announce@lists.sourceforge.net
- Adjust the #pootle channel notice. Use
/topic
to change the topic. - Email important users
- Tweet about it
Some possible cleanup tasks:
- Remove any RC builds from the sourceforge download pages (maybe?).
- Checkin any release notes and such (or maybe do that before tagging).
- Remove your pootle-release checkout.
- Update and fix these release notes.