Jump to: navigation, search

Release

The FreeIPA releases are organized according to roadmap. This page describes the FreeIPA release process and all it's steps.

Pre-release repository changes

Translations

Translations are handled by Weblate platform at https://translate.fedoraproject.org/projects/freeipa/ Weblate periodically pushes updates as pull requests to Github mirror of FreeIPA. However, ``ipa.pot`` template needs to be updated beforehand so that Weblate would see new untranslated strings.

Update ipa.pot file:

IPA 4.5+
$ autoreconf -i
$ ./configure
$ make -C po ipa.pot-update
``ipa.pot`` is always generated during build, there is no ``ipa.pot`` in git tree in versions before 4.8.8. For newer versions we commit ``ipa.pot`` due to integration with Weblate.
IPA 4.4 and lower
$ make -C install/po update-pot
!!! Don't forgot to put these changes to commit with translations.

The changes to ``ipa.pot`` have to be submitted as a separate pull request upstream. Note that currently we have several issues with Weblate ordering of translations in the generated PO files, so pull requests from Weblate and ``ipa.pot`` file changes are a bit "noisy".

Remove empty translations from *.po files

IPA 4.5+
$ make -C po strip-po
$ make -C po strip-pot
IPA 4.4 and older
$ make -C install/po update-po

Push (send patch) with new translations

$ git add
$ git commit
$ git push

Update Contributors.txt

Make sure that Contributors.txt file is updated with the Developer or other contributors. update-contributors.py can be used for automating this task.


Create release notes

As first create draft and send it on review on freeipa-devel list.

Use script from FreeIPA release tools against a clean HTTP clone of https://github.com/freeipa/freeipa.

Example:

python release-notes.py 4.5.0 2017-03-14 4.4.4 4.5.0 release-4-4-1..master "FreeIPA 4.5.0" -m  "Freeipa 4.4.3" "FreeIPA 4.4.4"  "FreeIPA 4.5" > release_notes_4-5-0 
python3 release/release-notes.py 4.9.7 2021-08-19 4.9.6 4.9   release-4-9-6..origin/ipa-4-9 "FreeIPA 4.9"  --links --token-file ~/.ipa/pagure.token --repo=/home/USER/src/freeipa-clean/ > release_notes-4-9-7

Use options --links to generate wiki format links for wiki as well.

See the TODO in the output. Remove extraneous tickets and fill the Enhancements and Known Issues sections out.

Create a wiki page for the particular release, update missing parts. When {{Release}} template is properly used, the release gets added to FreeIPA Release category and listed on the front page and in Downloads page.

You can use pandoc to convert the generated release notes to asciidoc format.

pandoc -f mediawiki -t asciidoc release-notes.mediawiki-o release-notes.txt

And then use sed to convert it to adapt it for email use:

sed -e "/^::/d;/ ;;/d;/^'''''/d;/^\[\[.*\$/d;" -i release-notes.txt

You can send this announcement to freeipa-users and freeipa-devel mailing lists.

Tagging the tree

The IPA master source is on pagure. Do all git work directly against a clean pull from there, named freeipa-writable to differenciate it from your devel pull.

Examples for our current tagging scheme:

  • alpha_1-4-0-1 - first alpha of 4.0.1
  • beta_3-4-0-1 - third beta of 4.0.1
  • rc_2-4-0-1 - second release candidate of 4.0.1
  • release-4-0-1 - 4.0.1 final

Process

Once we've confirmed that the tree is frozen, that all bugs we want fixed are fixed, we create a new tag:

$ git checkout master
$ git fetch
$ git rebase origin/master

FixMe: checkout the proper branch instead. Do not tag master!

Bump FreeIPA in VERSION[.m4], make sure that git snapshot versioning is disabled (package from tagged commit and tarball must have the same version) and commit:

$ vim VERSION.m4
  * set versions
  * set IPA_VERSION_IS_GIT_SNAPSHOT to  no
$ git commit -a -m "Become IPA X.Y.Z"

Make a signed tag:

$ git tag -s -m "tagging IPAv4 X.Y.Z" release-x-y-z
$ git verify-tag release-x-y-z

Note: this step requires you to have properly configured git for signing.

If you are signing remotely you may need to set environment variable export GPG_TTY=$(tty) and be sure to have the pinentry package installed.

Check the pushed changes (version update commit + tags) and push when OK:

$ git push origin <remote-branch> --tags --dry-run

Creating a new branch

We create branches on new X or Y releases. Use:

$ git log master

and note down the commit id of the 'Become IPA x.y' commit, then create the branch locally:

$ git branch ipa-x-y <commit-id>

updating branching information for fastcheck:

$ vim VERSION.m4
 * change IPA_GIT_BRANCH to define(IPA_GIT_BRANCH, ipa-IPA_VERSION_MAJOR-IPA_VERSION_MINOR)
$ git commit ...

finally push the new branch upstream:

$ git push origin ipa-x-y

Weblate: Please create new component in Weblate for the new branch.

Building the sources

If doing a pre release pull a fresh tree to do the builds into a separate directory:

$ git clone https://pagure.io/freeipa.git freeipa-x-y-z
$ cd freeipa-x-y-z

Make absolutely sure I have the right code by switching to the tag:

$ git checkout release-x-y-z

Create tarball

IPA 4.5+

Create tarball

$ cat VERSION.m4
   IPA_VERSION_IS_GIT_SNAPSHOT must be  no

If IPA_VERSION_IS_GIT_SNAPSHOT == yes go back to previous section, set no and tag again! Tarball must be the same as tagged version

$ ./autogen.sh
$ make dist

IPA 4.4 and older

Make RPMs:

$ make IPA_VERSION_IS_GIT_SNAPSHOT=no rpms

Sign and upload tarball

Create a detached signature:

$ gpg2 --default-key <IPA MASTER KEYID> --armor --detach-sign freeipa-x.y.z.tar.gz
$ gpg2 --verify freeipa-x.y.z.tar.gz.asc

Upload tarball and signature to pagure.io: https://pagure.io/freeipa/releases

If you signing key is not in the Verify Release Signature guide, append it to the list and gpg verify command.

Updating the COPR repository

When a new version is released, it has to be added into the corresponding COPR repository. The dependencies also need to be checked:

  • note the Fedora versions for the release, listed in the *Description* of the COPR repository (for instance ipa-4-6 branch is for Fedora 26 and Fedora 27)
  • for each Fedora version found above, install the freeipa-* packages into a system which has been updated with packages coming exclusively from fedora, fedora-updates and the COPR repository
  • check that the installed version is the one that was just released into COPR. If an older version is picked, it means that some dependencies are missing. You can run sudo dnf update freeipa-server to find the list of missing dependencies, for instance:
nothing provides pki-ca >= 10.5.1-2 needed by freeipa-server-4.6.2-0.fc26.x86_64
  • if some dependencies are missing, you will have to add them to the copr repository

Releasing to Fedora

All FreeIPA releases (except some internal Alpha or Beta versions) are released also to Fedora. See guidelines and help regarding the release process in Fedoraproject.org HOWTO.

Spec file changes

Fedora downstream spec file is usually being rebased to upstream version when a new Fedora is out. Then only a diff between versions is being applied (assuming you are in a directory with FreeIPA repo which is checked out on the new tag):

$ git diff release-x-y-z freeipa.spec.in > /tmp/spec.patch  # release-x-y-z is last released version
$ sed -i "s/freeipa.spec.in/freeipa.spec/g" /tmp/spec.patch
$ cd /path/to/fedora/freeipa/repo
$ patch -p1 < /tmp/spec.patch

Then, you just need to manually merge any conflicting changes (changelog entries are not merged) and you are done.

Create a changelog entry with a link to the Release Notes page on the wiki. For a minor release, list the main bugs fixed in this release, and the major updated dependencies

Closing Bugzillas

When a Fedora update system entry is being created, add all related POST Red Hat Bugzilla bugs of the released Fedora version to the list of fixed bugs (link to query) to the list of fixed Bugzillas so that they are automatically closed when the package is released to Fedora repos.

Release to PyPI

FixMe: probably obsolete.

Test PyPI

First try to upload FreeIPA to testing instance of PyPI . Your account must be have permissions to upload to the PyPI packages freeipa, ipa, ipaclient, ipalib, ipapython, ipaplatform, and ipaserver on both PyPI and Test PyPI. The instances have separate user databases.

Create '~/.pypirc" config file as following

[distutils]
index-servers=
    pypi
    testpypi

[testpypi]
repository=https://test.pypi.org/legacy/
username = <your user name goes here>
password = <your test password goes here>

[pypi]
repository=https://upload.pypi.org/legacy/
username = <your user name goes here>
password = <your live password optionally goes here>

First start by checking out the release tag and creating a clean build environment:

git checkout release-x-y-z
./autogen.sh
make clean

Create PyPI packages (both regular wheels and placeholder packages). The wheels are placed in 'dist/pypi':

make pypi_packages

Upload wheels using twine (https://wiki.python.org/moin/TestPyPI), replace 4.8.0 with correct version. It should be eight wheels in total.

twine upload --sign -r testpypi ./dist/pypi/*-4.8.0-*.whl

Test if Test PyPI works:

 python3 -m venv build/testenv3
 build/testenv3/bin/pip install --extra-index-url=https://testpypi.python.org/pypi ipaclient==4.8.0

The pip command should download 4.6.1 from TestPyPI, all dependencies from main PyPI.

PyPI

When Test PyPI was sucesfull, execute the same steps production version of PyPI.

twine upload --sign ./dist/pypi/*-4.8.0-*.whl

Doing a Major Release

When doing a major release, consider following extra steps:

  • Downloads - update list of active COPR repositories
  • Roadmap - consider updating information about planned or new releases
  • Documentation - update links and version numbers
  • Build - update COPR repositories if new ones are introduced or old abandoned

Tickets administravia

FixMe: is this being done for 4.9.x?