Cellular Network Infrastructure

{{>toc}}

h1. Make a new release

The efforts to automate the release process are tracked in https://projects.osmocom.org/issues/1861

h2. When to make a new release

Various Osmocom projects depend on others.

*Proposed policy:*

* master branch is expected to depend on latest master branches of depended-upon projects

* make release of depended-upon projects if necessary before making non-library project release

* make sure that we have correct version dependencies before making non-library project release

Alternatively/additionally we can make timely releases of non-library projects (and corresponding depended-upon libraries):

* once per XX months?

* before every OsmoDevCon?

* once YY items accumulated in TODO-RELEASE file(see [[Make_a_new_release#TODO-RELEASE-file-format-and-maintenance|TODO-RELEASE file format]])

* when configuration/db format changes?

This would help to avoid batching too many changes together and to adhere to RERO better - see "2015-Why-and-HowShould-OpenSource-ProjectsAdopt-Time-Based-Releases.pdf":https://www.researchgate.net/publication/268815678_Why_and_How_Should_Open_Source_Projects_Adopt_Time-Based_Releases

h2. Versioning considerations for libraries

Every osmocom library is built using libtool's version-info system. This system format and algorithm to update the versions is documented in "here":https://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html#Updating-version-info.

However, debian packaging system follows a different versioning convention, but conveniently the debian versioning system can be deduced from libtool's version-info. More information can be found in "here":https://autotools.io/libtool/version.html.

Specially interesting is the warning section:

> A common mistake is to assume that the three values passed to -version-info map directly into the three numbers at the end of the library name. This is not the case, and indeed, current, revision and age are applied differently depending on the operating system that one is using.

> For Linux, for instance, while the last two values map directly from the command-line, the first is calculated by subtracting age from current. On the other hand, on modern FreeBSD, only one component is used in the library version, which corresponds to current. 

More related information on the version translation procedure can be found here: "[1]":https://github.com/haskell/cabal/issues/4052#issuecomment-258044949 "[2]":https://stackoverflow.com/questions/36734105/how-is-the-version-number-in-library-names-generated

Summary: For libtool's system @current:revision:age@, it gets translated into version number @major.age.revision@, where @major=current-age@, reflecting the fact that ABIs can be backwards compatible. Debian uses @major@ to generate the package name.

The following command, when run on a shared library, will output the name to be used for the Debian package containing that shared library:

<pre>

objdump -p library.so \

    | sed -n -e's/^[[:space:]]*SONAME[[:space:]]*//p' \

    | LC_ALL=C sed -r -e's/([0-9])\.so\./\1-/; s/\.so(\.|$)//; y/_/-/; s/(.*)/\L&/'

</pre>

h2. osmocom-release.mk

The @osmo-release.mk@ helper (installed by @libosmocore-dev@) available via @make release@ takes care of

* version bump

* debian/changelog update

* commit

* sign

* tag

Feel free to send patches implementing further automation as you see fit.

You can alternatively run osmo-release.mk directly from your git repo in /foo/bar/libosmocore by using:

<pre>

PATH="$PATH:/foo/bar/libosmocore" make REL=minor release --include-dir="/foo/bar/libosmocore"

</pre>

h3. Dependencies

The @osmo-release.mk@ requires several extra dependencies. Make sure you have them installed in your system:

* bumpversion

* git-buildpackage

* devscripts

h3. TODO-RELEASE file format and maintenance

* all the strings which contain @#@ considered comment and will be ignored

* actual entries consists of 3 tab-separated fields:

# library - name of the library affected (should correspond to @lib*.pc.in@ file in project's root directory)

# what - API or ABI change (used as a guidance to properly bump @*_LIBVERSION@)

# description - textual description (will end up in changelog)

When change affecting library's API/ABI is made then new entry should be added to TODO-RELEASE according to the format above. The file will be claned-up automatically by @make release@ command.

h2. How to make a new release

First we outline specific steps for different project types, then common part.

* Grep for @PKG_CHECK_MODULES@ in @configure.ac@, and build with dependencies listed there (check versions after @>=@). If cannot compile, adjust the versions there so compilation works. eg: @osmo-ci.git/scripts/osmo-depcheck.py -w /tmp/depcheck -b -j 8 -u /home/$USER/where-my-local-git-repos-are/ osmo-ggsn@

* Adjust dependency versions in @debian/control@ (under @Build-Depends@) to match those of configure.ac

* Adjust dependency version in @contrib/*.spec.in@ to match those of configure.ac

* Make sure patches under @debian/patches@ still apply correctly.

h3. Extra steps for Libraries

Some extra previous steps are required if the project installs a public shared library.

* modify @*_LIBVERSION@ in @src/Makefile.am@ as necessary according to TODO-RELEASE file. Usually the easiest is using @git diff $OLD_RELEASE -- include/foobar/@ to check API/ABI changes, and implementation changes similarly with @git diff $OLD_RELEASE -- src/foobar/@

* if necessary ("@major = current - age@" component of @*LIBVERSION@ was bumped, package name changing as a result) then:

** Rename @debian/lib*.install@ to match the name change. See [[Make_a_new_release#Versioning-considerations-for-libraries|Versioning considerations for libraries]].

** Adjust package names in @contrib/*.spec.in@ accordingly.

** Adjust package names in @debian/control@ accordingly. Specifically look for "Package" and "Depends" attributes.

** Some projects containing both binaries and libraries (@osmo-ggsn@, @libosmo-sccp@) also state the library version in dh_strip lines in @debian/rules@. That one needs to be updated too to match the new library version.

Upon major libversion change ("old_major" -> "new_major"), the change pattern in general follow this structure:

* @"s/${libname}${old_major}/${libname}${new_major}/g"@

* @"s/${libname}.so.${old_major}/${libname}.so.${new_major}/g"@

The release helper is trying to be smart about it and prevent making new library release with non-empty TODO-RELEASE file if @*_LIBVERSION@ is not adjusted beforehand.

h3. Release steps

By default @make release@ prepares 'patch' release but you can manually specify any of 'major/minor/patch' as necessary - see http://semver.org/ for details.

* Run @git fetch --tags@ to ensure your local copy of the repository has the latest tags.

* Create a new branch from where you would like to create a new release (master or a previous release) and name it @yourname/release@

* Make sure all the manual changes you want in the release commit are staged (@git add@), (see previous sections about changes needed).

* Run @make REL=minor release@

* an editor will be opened in case you want to reword the release commit. Useful if you want to add any remarks on the actions taken.

* inspect the latest commit which was just created

* adjust it if necessary and re-sign (see [[Make_a_new_release#How-to-retag-a-new-release|Re-tag new release]])

* push commit for review to gerrit and ask somebody to review and merge it quickly (to avoid other commits being merged in between).

* Once merged, make sure the merged release commit did not change (due to in-between merges), then push the release tag with @git push gerrit --tags@

* consider preparing article for https://osmocom.org/news/ and sending announcement to appropriate ML for major release once release commit passed the review

In case you want to undo the release commit you did locally:

* @git tag -d TAG_JUST_CREATED@

* @git reset --soft HEAD^@

* @git restore --staged debian/changelog && git restore debian/changelog@

* Do your modifications

* Proceed again with the release steps listed above

h2. Which new release to make

Use following guidelines when choosing release type:

* major - ?? TBD

* minor - ?? TBD

* patch - ?? TBD

If unsure - ask in corresponding ML.

h2. Deprecation policy

Functions/interfaces marked as deprecated for X releases of type Y can be removed in next Z release.

TBD: what's appropriate value for X? which Y and Z (from major/minor/patch) should we use?

h2. How to (re)tag a new release

This might be necessary if previous release was made manually with some mistakes which have to be corrected and amended to the release commit.

<pre>

git tag -s 0.4.0 -f -m "Release v0.4.0 on 2017-08-25."

</pre>

This will automatically (re)sign the latest commit. You can specify which commit to sign explicitly.

Say, for example, the git hash is @012342abcdefg@ and the next open version is 0.1.3:

<pre>

git tag -s 0.1.3 012342abcdefg -m "release 0.1.3"

</pre>

(If @gpg@ complains, see [[Make a new release#GPG-Have-a-matching-user-id|GPG: Have a matching user id]].)

Verify that git picks up the new version tag:

<pre>

$ git describe

0.1.3-3-g1f95179

</pre>

N. B: *For your local build, _nothing will change_ until you delete the @.version@ file and completely rebuild:*

<pre>

rm .version

autoreconf -fi

./configure

make

cat .version

</pre>

This should show the same as @git describe@.

When you're convinced that all is in order, push the new tag:

<pre>

git push origin 0.1.3

</pre>

If anything went wrong, you can delete the tag (locally) by

<pre>

git tag -d 0.1.3

</pre>

and, if you've already pushed it, by

<pre>

git push --delete origin 0.1.3

</pre>

h2. GPG: Have a matching user id

By default, @git tag -s@ takes your author information to lookup the secret GPG key to sign a tag with.

If the author+email do not exactly match one of the key's @uid@s, you will get this error:

<pre>

gpg: signing failed: secret key not available

</pre>

Verify: say, your author+email info in your git config says "John Doe <john@doe.net>", try

<pre>

gpg --list-secret-keys "John Doe <john@doe.net>"

</pre>

If this fails, GPG won't find the right key automatically.

Ways to resolve:

* Use @git tag -u <key-id>@

* Edit your secret key to add a uid that matches your author information

<pre>

gpg --edit-key john@doe.net

gpg> adduid

# enter details to match the git author

gpg> save

</pre>

h1. Creating a patch release

Sometimes we want to create a patch release to apply an important fix to an older major/minor release. Assuming you're in libosmocore and want to create 1.3.1 off 1.3.0, this works as follows:

# (Locally checkout 1.3.0 as a new branch called rel-1.3.1)

<pre>

git checkout -b rel-1.3.1 1.3.0

</pre>

# Create a rel-1.3.1 branch in gerrit

<pre>

git push gerrit rel-1.3.1:refs/heads/rel-1.3.1

</pre>

# Do whatever local modifications such as cherry-picking of fixes, ...

# Perform the release process as outlined above, using 'REL=patch'

<pre>

make REL=patch release

</pre>

# Push the changes for review to the rel-1.3.1 branch

<pre>

git push gerrit HEAD:refs/for/rel-1.3.1

</pre>

# Perform gerrit review, merge patches in gerrit UI

# Do @git fetch gerrit@ and make sure your local branch with your tag points to the remote one (eg @gitk --all@ or @git show@).

# Push the tag to the repo, *after the patches were merged* to that branch

<pre>

git push gerrit 1.3.1

</pre>

# Remove the temporary branch

<pre>

git push gerrit :rel-1.3.1

</pre>

h1. Dependency graph

This section aims at providing a dependency graph of the osmocom cellular network infrastructure projects in case a cascade of releases is intended:

{{graphviz_link()

digraph G {

    libusrp -> {osmo_trx};

    libas1nc -> {osmo_iuh, osmo_msc, openbsc, osmo_hnodeb};

    libsmpp34 -> {osmo_msc, openbsc};

    libgtpnl -> {osmo_ggsn};

    libosmocore -> {libosmo_abis, libosmo_netif, libosmo_sccp, osmo_iuh, osmo_ggsn, osmo_sgsn, osmo_mgw, osmo_msc, osmo_hlr, osmo_bsc, osmo_bts, osmo_pcu, osmo_trx, openbsc, osmo_sip_connector, osmo_pcap, osmo_gbproxy, osmo_hnodeb, osmo_cbc, osmo_smlc, osmo_uecups};

    osmo_gsm_manuals -> {osmo_pcu, osmo_trx, osmo_sip_connector, osmo_hlr, libosmo_sccp, osmo_sgsn, osmo_bsc, osmo_ggsn, osmo_msc, osmo_mgw, osmo_bts};

    libosmo_abis -> {libosmo_netif, osmo_sgsn, osmo_msc, osmo_hlr, osmo_bsc, osmo_mgw, osmo_bts, openbsc, osmo_hnodeb};

    libosmo_netif -> {libosmo_sccp, osmo_iuh, osmo_sgsn, osmo_mgw, osmo_msc, osmo_bsc, openbsc, osmo_hnodeb, osmo_cbc, osmo_uecups};

    libosmo_sccp -> {osmo_iuh, osmo_sgsn, osmo_msc, osmo_bsc, openbsc, osmo_hnodeb, osmo_smlc};

    osmo_iuh -> {osmo_msc, osmo_sgsn, openbsc, osmo_hnodeb};

    osmo_ggsn -> {osmo_sgsn};

    osmo_mgw -> {osmo_msc, osmo_bsc};

    osmo_hlr -> {osmo_msc, osmo_sgsn};

}

}}