Make a new release » History » Version 40
msuraev, 08/28/2017 09:27 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 | 25 | msuraev | Alternatively/additionally we can make timely releases (once per XX months? before every OsmoDevCon?) of non-library projects (and corresponding depended-upon libraries) to avoid batching too many changes together and to adhere to RERO better - see http://scalare.org/wp-content/uploads/2015/06/2015-Why-and-HowShould-OpenSource-ProjectsAdopt-Time-Based-Releases.pdf |
17 | 20 | msuraev | |
18 | 17 | msuraev | h2. How to make a new release |
19 | |||
20 | 39 | msuraev | First we outline specific steps for different project types, than common part. The @osmo-release.mk@ helper (installed by @libosmocore-dev@) available via @make release@ takes care of |
21 | 1 | neels | |
22 | 35 | msuraev | * version bump |
23 | * debian/changelog update |
||
24 | * commit |
||
25 | * sign |
||
26 | * tag |
||
27 | |||
28 | Feel free to send patches implementing further automation as you see fit. |
||
29 | |||
30 | 17 | msuraev | h3. Library release |
31 | 30 | msuraev | |
32 | 1 | neels | * modify @*_LIBVERSION@ in @Makefile.am@ as necessary according to TODO-RELEASE file |
33 | 34 | msuraev | |
34 | 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. |
||
35 | 1 | neels | |
36 | h3. Non-library release |
||
37 | |||
38 | 35 | msuraev | Nothing special is required ATM. |
39 | 1 | neels | |
40 | 30 | msuraev | h3. Common steps |
41 | 1 | neels | |
42 | 30 | msuraev | Be default @make release@ prepares 'patch' release but you can manually specify any of 'major/minor/patch' as necessary - see http://semver.org/ for details. |
43 | 1 | neels | |
44 | 36 | msuraev | * @make REL=minor release@ |
45 | 30 | msuraev | * inspect the latest commit which was just created |
46 | 32 | msuraev | * adjust it if necessary and re-sign (see [[Make_a_new_release#How-to-retag-a-new-release|Re-tag new release]]) |
47 | 30 | msuraev | * push commit for review using @git review -f@ (see [[Gerrit]] for alternatives) |
48 | * push the release tag by @git push gerrit --tags@ |
||
49 | 38 | msuraev | * consider preparing article for https://osmocom.org/news/ and sending announcement to appropriate ML for major release once release commit passed the review |
50 | 1 | neels | |
51 | 30 | msuraev | h3. How to (re)tag a new release |
52 | 1 | neels | |
53 | 36 | msuraev | <pre> |
54 | git tag -s 0.4.0 -f -m "Release v0.4.0 on 2017-08-25." |
||
55 | </pre> |
||
56 | 30 | msuraev | |
57 | This will automatically (re)sign the latest commit. You can specify which commit to sign explicitly. |
||
58 | 3 | neels | |
59 | 1 | neels | Say, for example, the git hash is @012342abcdefg@ and the next open version is 0.1.3: |
60 | 9 | neels | <pre> |
61 | 1 | neels | git tag -s 0.1.3 012342abcdefg -m "release 0.1.3" |
62 | </pre> |
||
63 | 8 | neels | |
64 | 1 | neels | (If @gpg@ complains, see [[Make a new release#GPG-Have-a-matching-user-id|GPG: Have a matching user id]].) |
65 | 4 | neels | |
66 | 1 | neels | Verify that git picks up the new version tag: |
67 | <pre> |
||
68 | $ git describe |
||
69 | 0.1.3-3-g1f95179 |
||
70 | </pre> |
||
71 | 11 | neels | |
72 | *For your local build, _nothing will change_ until you delete the @.version@ file |
||
73 | and completely rebuild:* |
||
74 | 1 | neels | |
75 | <pre> |
||
76 | 10 | neels | rm .version |
77 | autoreconf -fi |
||
78 | 1 | neels | ./configure |
79 | make |
||
80 | cat .version |
||
81 | </pre> |
||
82 | |||
83 | This should show the same as @git describe@. |
||
84 | |||
85 | When you're convinced that all is in order, push the new tag: |
||
86 | |||
87 | <pre> |
||
88 | git push origin 0.1.3 |
||
89 | </pre> |
||
90 | 14 | neels | |
91 | 1 | neels | If anything went wrong, you can delete the tag (locally) by |
92 | 15 | msuraev | <pre> |
93 | 14 | neels | git tag -d 0.1.3 |
94 | </pre> |
||
95 | and, if you've already pushed it, by |
||
96 | <pre> |
||
97 | git push --delete origin 0.1.3 |
||
98 | 1 | neels | </pre> |
99 | 26 | msuraev | |
100 | h2. Deprecation policy |
||
101 | 27 | msuraev | |
102 | 26 | msuraev | Functions/interfaces marked as deprecated for X releases of type Y can be removed in next Z release. |
103 | 27 | msuraev | |
104 | 26 | msuraev | TBD: what's appropriate value for X? which Y and Z (from major/minor/patch) should we use? |
105 | 1 | neels | |
106 | h2. GPG: Have a matching user id |
||
107 | |||
108 | By default, @git tag -s@ takes your author information to lookup the secret GPG key to sign a tag with. |
||
109 | If the author+email do not exactly match one of the key's @uid@s, you will get this error: |
||
110 | |||
111 | <pre> |
||
112 | gpg: signing failed: secret key not available |
||
113 | </pre> |
||
114 | |||
115 | Verify: say, your author+email info in your git config says "John Doe <john@doe.net>", try |
||
116 | <pre> |
||
117 | gpg --list-secret-keys "John Doe <john@doe.net>" |
||
118 | </pre> |
||
119 | If this fails, GPG won't find the right key automatically. |
||
120 | |||
121 | Ways to resolve: |
||
122 | |||
123 | * Use @git tag -u <key-id>@ |
||
124 | * Edit your secret key to add a uid that matches your author information |
||
125 | <pre> |
||
126 | gpg --edit-key john@doe.net |
||
127 | gpg> adduid |
||
128 | # enter details to match the git author |
||
129 | gpg> save |
||
130 | </pre> |