Project

General

Profile

Proc-errata » History » Version 4

David Demelier, 02/13/2017 01:09 PM

1 4 David Demelier
h1. Writing errata
2 1 David Demelier
3
An errata has to be written when a bug is found in a release.
4
5
h2. Create a task
6
7
Create a task with *Bug* as tracker, mark it as *Urgent* and specify the current release branch in the custom field.
8
9
h2. Write the fix
10
11
Update to the current release branch:
12
13
<pre>
14
$ hg up release-x.y
15
</pre>
16
17
Write a unique revision and use the following commit template.
18
19 2 David Demelier
<pre>
20
Fix #TASK_NUMBER: short description
21 1 David Demelier
22 2 David Demelier
Explanation
23
24
Task: #TASK_NUMBER
25
Errata: YYYYMMDD
26
</pre>
27
28
h2. Export patch
29
30
Export the patch and sign it.
31
32 1 David Demelier
<pre>
33 2 David Demelier
hg export > YYYYMMDD.patch
34
gpg --sign --armor YYYYMMDD.patch
35
</pre>
36
37
Upload it in http://releases.malikania.fr/irccd/errata.
38
39
h2. New release
40
41
Then, do a usual release as described in [[proc-new-release|New release]].
42
43
h2. Wiki page
44
45
Create a new wiki page with the following template.
46
47 3 David Demelier
{{collapse(See template)
48 2 David Demelier
<pre>
49 1 David Demelier
h1. Errata YYYYMMDD
50
51
*Topic*: 
52
*Category*: As specified in tasks
53
*Corrected*: [[Version-x-y-z|x.y.z]] (or revision r???)
54
*Affected versions*: [[Version-x-y-z|x.y.z]]
55
*Task*: #???
56
57
h1. Background
58
59
Short explanation about the feature/context.
60
61
h1. Problem
62
63
Short description about the problem.
64
65
h1. Solution
66
67
Upgrade to a newer version if applicable or apply one of the following fixes:
68
69
h2. Using Mercurial
70
71
If you don't have a local copy:
72
73
<pre>
74
hg clone -u release-x.y http://hg.malikania.fr/irccd
75
</pre>
76
77
If you already have a local copy:
78
79
<pre>
80
cd /path/to/irccd
81
hg pull
82
hg up release-x.y
83
</pre>
84
85
And install new version of irccd.
86
87
h2. Using patch
88
89
Download the following patch:
90
91
* http://releases.malikania.fr/irccd/errata/YYYYMMDD.patch
92
* http://releases.malikania.fr/irccd/errata/YYYYMMDD.patch.asc
93
94
Apply it:
95
96
<pre>
97
cd /path/to/irccd/
98
patch -p1 < /path/to/YYYYMMDD.patch
99
</pre>
100
</pre>
101 2 David Demelier
}}