-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathrelease.html
More file actions
293 lines (260 loc) · 10.9 KB
/
release.html
File metadata and controls
293 lines (260 loc) · 10.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Making a release</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/pitivi.svg" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Pitivi Developer Documentation</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Pitivi" data-hotdoc-ref="release.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="making-a-release">Making a release</h1>
<p>Ideally these instructions are in line with the <a href="https://live.gnome.org/MaintainersCorner/Releasing">GNOME releasing
process</a>.</p>
<p>We make two types of releases:</p>
<ul>
<li>regular releases, when we have new features or improvements, and</li>
<li>"smaller" bug-fix releases, when a regular release needs patching.</li>
</ul>
<p>The regular releases have the version number YYYY.MM, and the bug-fix releases
have the version number YYYY.MM.Z, where Z is hopefully a relatively small
number (1, 2, 3...).</p>
<p>Most of the steps below should be done in the <a href="HACKING.html">development
environment</a>:</p>
<pre><code>$ source bin/pitivi-env
(ptv-flatpak) $ _
</code></pre>
<ol start="0">
<li>
<p>Freeze the strings</p>
<ul>
<li>Post to <a href="https://discourse.gnome.org/tag/i18n">gnome-i18n</a>
to inform the translators the strings have been frozen and that
in <strong>one week</strong> the release will be cut.</li>
<li>It would be good to start preparing a blogpost already.</li>
</ul>
</li>
<li>
<p>Check <a href="https://gitlab.gnome.org/GNOME/pitivi/-/milestones">GitLab</a></p>
<ul>
<li>Make sure there are no significant issues open against the current milestone.</li>
<li>Move the remaining open issues somewhere else, for example to the next milestone.</li>
<li>Close the current milestone.</li>
</ul>
</li>
<li>
<p>Check your local dev env:</p>
<ul>
<li>
<p>Make sure your sandbox is using the latest GStreamer release:</p>
<pre><code>$ ptvenv --update
</code></pre>
</li>
<li>
<p>Check there are no uncommitted changes:</p>
<pre><code>$ git status
</code></pre>
</li>
</ul>
</li>
<li>
<p>Update the following files:</p>
<ul>
<li>
<a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/meson.build">meson.build</a>:
If doing a bugfix release, make sure the micro (Z) from the version number has
been increased. If doing a regular release, update the version number with the
current year and month and remove the micro, if any. Normally this is the
same as the name of the GitLab milestone you just archived.</li>
<li>
<a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/NEWS">NEWS</a>:
Compose the exec summary of changes, at the top. This ends up in the <code>.news</code>
file at <a href="https://download.gnome.org/sources/pitivi/">download.gnome.org/sources/pitivi</a>.</li>
<li>
<a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/data/org.pitivi.Pitivi.appdata.xml.in">data/org.pitivi.Pitivi.appdata.xml.in</a>:
Run <code>appstreamcli news-to-metainfo NEWS data/org.pitivi.Pitivi.appdata.xml.in</code>.</li>
<li>
<a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/AUTHORS">AUTHORS</a>:
If there are new maintainers.</li>
</ul>
</li>
<li>
<p>Commit the changes:</p>
<pre><code>$ git commit -a -m "Release <version-number>"
</code></pre>
</li>
<li>
<p>Create the distribution archive:</p>
<pre><code>$ ninja -C mesonbuild/ dist
$ ls -l mesonbuild/meson-dist/*.tar.*
</code></pre>
<p>On an X system, <code>ninja dist</code> might not work because the unit tests fail
because of X. In this case, stop X with <code>sudo systemctl stop gdm</code> and use a
fake X server: <code>xvfb-run /.../pitivi/build/flatpak/pitivi-flatpak ninja -C mesonbuild/ dist</code>.</p>
<p>Install it on a real system and give it a spin. For example on Archlinux:</p>
<pre><code>$ cd /tmp
$ asp update pitivi
$ asp checkout pitivi
$ cd /tmp/pitivi/repos/community-x86_64/
$ cp .../pitivi-YYYY.MM.Z.tar.xz .
$ vim PKGBUILD
... Update "pkgver"
... Make sure the filename at the end of "source" matches the copied file
... Update "sha256sums"
$ makepkg
$ makepkg -i
$ pitivi
</code></pre>
</li>
<li>
<p>Create a tag and push it to the official repository. The TAG must always include the micro. This means when doing a regular release with version number YYYY.MM, the TAG is YYYY.MM.0. When doing a bug-fix release, the version number already includes a micro, so it's all fine.</p>
<pre><code>$ git push origin master
$ git tag -a <TAG> -m "Release <version-number>"
$ git push origin <TAG>
</code></pre>
<p>We use tag YYYY.MM.0 instead of YYYY.MM because we want to have the option of
later creating the YYYY.MM branch to the official repository, since it's not
possible to have both a tag and a branch with the same name. This branch
would gather backported fixes and be used for doing future YYYY.MM.Z bug-fix
releases.</p>
</li>
<li>
<p>Publish the archive on Gnome:</p>
<pre><code>$ scp mesonbuild/meson-dist/pitivi-YYYY.MM.tar.xz GNOME-USER@master.gnome.org:
$ ssh GNOME-USER@master.gnome.org -t ftpadmin install pitivi-YYYY.MM.tar.xz
</code></pre>
<p>The tarball will appear on
https://download.gnome.org/sources/pitivi/YYYY.MM/pitivi-YYYY.MM.tar.xz</p>
</li>
<li>
<p>Spread the word about the release</p>
<ul>
<li>Send an <a href="https://lists.freedesktop.org/archives/gstreamer-devel/2017-September/065566.html">email</a> to gstreamer-devel@lists.freedesktop.org</li>
<li>Reply to the connected string freeze <a href="https://discourse.gnome.org/tag/i18n">post</a>, expressing gratitude to the translators.</li>
<li>
<a href="https://www.archlinux.org/packages/community/x86_64/pitivi/">Archlinux</a>, click "Flag Package Out-of-Date".</li>
<li>
<a href="https://packages.debian.org/pitivi">Debian</a>, click the "unstable" Debian version and look for "maintainer".</li>
<li>
<a href="https://packages.fedoraproject.org/pkgs/pitivi/pitivi/">Fedora</a>, look for "You can contact the maintainers of this package via email at".</li>
</ul>
</li>
<li>
<p>Update the <a href="https://www.pitivi.org/releases.txt">releases.txt</a> file for the
app's update notification feature in
<a href="https://gitlab.gnome.org/Infrastructure/pitivi-web/-/blob/master/static/releases.txt">pitivi-web</a>.</p>
</li>
<li>
<p>Bump the Z in the version number in
<a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/meson.build">meson.build</a>,
for example if it was a regular release: <code>2020.09</code> -> <code>2020.09.1</code> or if it was a
bug-fix release: <code>2020.09.1</code> -> <code>2020.09.2</code>.
Push to the official repo:</p>
<pre><code>$ git commit -a -m "Back to development"
$ git push origin master
</code></pre>
</li>
</ol>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://gitlab.gnome.org/GNOME/pitivi/edit/master/docs/release.md" data-hotdoc-role="edit-button">Edit on GitLab</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>