Project

General

Profile

Make a new release » History » Version 70

pespin, 08/30/2018 10:20 AM

1 22 msuraev
{{>toc}}
2
3 2 neels
h1. Make a new release
4 1 neels
5 13 msuraev
The efforts to automate the release process are tracked in https://projects.osmocom.org/issues/1861
6
7 17 msuraev
h2. When to make a new release
8 1 neels
9 16 msuraev
Various Osmocom projects depend on others.
10 1 neels
11 28 msuraev
*Proposed policy:*
12 16 msuraev
* master branch is expected to depend on latest master branches of depended-upon projects
13 24 msuraev
* make release of depended-upon projects if necessary before making non-library project release
14
* make sure that we have correct version dependencies before making non-library project release
15 1 neels
16 41 msuraev
Alternatively/additionally we can make timely releases of non-library projects (and corresponding depended-upon libraries):
17
* once per XX months?
18
* before every OsmoDevCon?
19 46 msuraev
* once YY items accumulated in TODO-RELEASE file(see [[Make_a_new_release#TODO-RELEASE-file-format-and-maintenance|TODO-RELEASE file format]])
20 41 msuraev
* when configuration/db format changes?
21
22 62 pespin
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":http://scalare.org/wp-content/uploads/2015/06/2015-Why-and-HowShould-OpenSource-ProjectsAdopt-Time-Based-Releases.pdf
23 20 msuraev
24 61 pespin
h2. Versioning considerations for libraries
25 1 neels
26 62 pespin
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.
27 1 neels
28 62 pespin
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.
29 61 pespin
Specially interesting is the warning section:
30
31 62 pespin
> 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.
32
> 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. 
33
34
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
35 52 pespin
36 61 pespin
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.
37
38 70 pespin
<pre>
39
The following command, when run on a shared library, will output the name to be used for the Debian package containing that shared library:
40
objdump -p library.so \
41
    | sed -n -e's/^[[:space:]]*SONAME[[:space:]]*//p' \
42
    | LC_ALL=C sed -r -e's/([0-9])\.so\./\1-/; s/\.so(\.|$)//; y/_/-/; s/(.*)/\L&/'
43
</pre>
44
45 61 pespin
h2. osmocom-release.mk
46
47
The @osmo-release.mk@ helper (installed by @libosmocore-dev@) available via @make release@ takes care of
48
49 35 msuraev
* version bump
50 57 pespin
* debian/changelog update
51
* commit
52 1 neels
* sign
53 57 pespin
* tag
54 1 neels
55
Feel free to send patches implementing further automation as you see fit.
56
57
You can alternatively run osmo-release.mk directly from your git repo in /foo/bar/libosmocore by using:
58
@PATH="$PATH:/foo/bar/libosmocore" make REL=minor release --include-dir="/foo/bar/libosmocore"@
59
60 61 pespin
h3. Dependencies
61 1 neels
62 61 pespin
The @osmo-release.mk@ requires several extra dependencies. Make sure you have them installed in your system:
63
* bumpversion
64
* git-buildpackage
65
* devscripts
66
67
h3. TODO-RELEASE file format and maintenance
68
69
* all the strings which contain @#@ considered comment and will be ignored
70
* actual entries consists of 3 tab-separated fields:
71
# library - name of the library affected (should correspond to @lib*.pc.in@ file in project's root directory)
72
# what - API or ABI change (used as a guidance to properly bump @*_LIBVERSION@)
73
# description - textual description (will end up in changelog)
74
75
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.
76
77
h2. How to make a new release
78
79
First we outline specific steps for different project types, then common part.
80
81
h3. Extra steps for Libraries
82
83
Some extra previous steps are required if the project installs a public shared library.
84
85 59 pespin
* modify @*_LIBVERSION@ in @src/Makefile.am@ as necessary according to TODO-RELEASE file
86 61 pespin
* if necessary ("current/age" component of @*_LIBVERSION@ was bumped) then rename @debian/lib*.install@ to match the change. See [[Make_a_new_release#Versioning-considerations-for-libraries|Versioning considerations for libraries]].
87 65 pespin
* if necessary (any of @debian/lib*.install@ were renamed) then adjust @debian/control@ accordingly.
88
* Some projects (osmo-ggsn) 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.
89 32 msuraev
90 30 msuraev
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.
91
92 61 pespin
h3. Release steps
93 1 neels
94 44 msuraev
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.
95
96 64 pespin
* Make sure all the changes you want in the release commit are staged (@git add@).
97 1 neels
* @make REL=minor release@
98 64 pespin
* 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.
99 44 msuraev
* inspect the latest commit which was just created
100
* adjust it if necessary and re-sign (see [[Make_a_new_release#How-to-retag-a-new-release|Re-tag new release]])
101
* push commit for review using @git review -f@ (see [[Gerrit]] for alternatives)
102
* push the release tag by @git push gerrit --tags@
103 1 neels
* consider preparing article for https://osmocom.org/news/ and sending announcement to appropriate ML for major release once release commit passed the review
104 64 pespin
105
In case you want to undo the release commit you did locally:
106
* @git tag -d TAG_JUST_CREATED@
107
* @git reset --soft HEAD^@
108
* @git reset HEAD debian/changelog && git checkout debian/changelog@
109
* Do your modifications
110
* Proceed again with the release steps listed above
111 45 msuraev
112
h2. Which new release to make
113
114
Use following guidelines when choosing release type:
115
* major - ?? TBD
116
* minor - ?? TBD
117 43 msuraev
* patch - ?? TBD
118 1 neels
119 43 msuraev
If unsure - ask in corresponding ML.
120
121
h2. Deprecation policy
122
123
Functions/interfaces marked as deprecated for X releases of type Y can be removed in next Z release.
124
125 55 pespin
TBD: what's appropriate value for X? which Y and Z (from major/minor/patch) should we use?
126 43 msuraev
127
h2. How to (re)tag a new release
128
129 47 msuraev
This might be necessary if previous release was made manually with some mistakes which have to be corrected and amended to the release commit.
130
131 36 msuraev
<pre>
132
git tag -s 0.4.0 -f -m "Release v0.4.0 on 2017-08-25."
133
</pre>
134 30 msuraev
135
This will automatically (re)sign the latest commit. You can specify which commit to sign explicitly.
136 3 neels
137 1 neels
Say, for example, the git hash is @012342abcdefg@ and the next open version is 0.1.3:
138 9 neels
<pre>
139 1 neels
git tag -s 0.1.3 012342abcdefg -m "release 0.1.3"
140
</pre>
141 8 neels
142 1 neels
(If @gpg@ complains, see [[Make a new release#GPG-Have-a-matching-user-id|GPG: Have a matching user id]].)
143 4 neels
144 1 neels
Verify that git picks up the new version tag:
145
<pre>
146
$ git describe
147
0.1.3-3-g1f95179
148
</pre>
149 11 neels
150 42 msuraev
N. B: *For your local build, _nothing will change_ until you delete the @.version@ file and completely rebuild:*
151 1 neels
152
<pre>
153 10 neels
rm .version
154
autoreconf -fi
155 1 neels
./configure
156
make
157
cat .version
158
</pre>
159
160
This should show the same as @git describe@.
161
162
When you're convinced that all is in order, push the new tag:
163
164
<pre>
165
git push origin 0.1.3
166
</pre>
167 14 neels
168 1 neels
If anything went wrong, you can delete the tag (locally) by
169 15 msuraev
<pre>
170 42 msuraev
git tag -d 0.1.3
171
</pre>
172
and, if you've already pushed it, by
173
<pre>
174
git push --delete origin 0.1.3
175
</pre>
176 1 neels
177
h2. GPG: Have a matching user id
178
179
By default, @git tag -s@ takes your author information to lookup the secret GPG key to sign a tag with.
180
If the author+email do not exactly match one of the key's @uid@s, you will get this error:
181
182
<pre>
183
gpg: signing failed: secret key not available
184
</pre>
185
186
Verify: say, your author+email info in your git config says "John Doe <john@doe.net>", try
187
<pre>
188
gpg --list-secret-keys "John Doe <john@doe.net>"
189
</pre>
190
If this fails, GPG won't find the right key automatically.
191
192
Ways to resolve:
193
194
* Use @git tag -u <key-id>@
195
* Edit your secret key to add a uid that matches your author information
196
<pre>
197
gpg --edit-key john@doe.net
198
gpg> adduid
199
# enter details to match the git author
200
gpg> save
201
</pre>
202 56 pespin
203
h2. Dependency graph
204
205
This section aims at providing a dependency graph of the osmocom cellular network infrastructure projects in case a cascade of releases is intended:
206
207
{{graphviz_link()
208
digraph G {
209 66 pespin
    libusrp -> {osmo_trx};
210 56 pespin
    libas1nc -> {osmo_iuh, osmo_msc, openbsc};
211
    libsmpp34 -> {osmo_msc, openbsc};
212
    libgtpnl -> {osmo_ggsn};
213 67 pespin
    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};
214 60 pespin
    libosmo_abis -> {libosmo_netif, osmo_sgsn, osmo_msc, osmo_hlr, osmo_bsc, osmo_bts, openbsc};
215 56 pespin
    libosmo_netif -> {libosmo_sccp, osmo_iuh, osmo_sgsn, osmo_mgw, osmo_msc, osmo_bsc, openbsc};
216
    libosmo_sccp -> {osmo_iuh, osmo_sgsn, osmo_msc, osmo_bsc, openbsc};
217 63 pespin
    osmo_iuh -> {osmo_msc, osmo_sgsn, openbsc};
218 56 pespin
    osmo_ggsn -> {osmo_sgsn};
219
    osmo_mgw -> {osmo_msc, osmo_bsc};
220 69 pespin
    osmo_hlr -> {osmo_msc, osmo_sgsn};
221 56 pespin
}
222
}}
Add picture from clipboard (Maximum size: 48.8 MB)