Writing errata¶

An errata has to be written when a bug is found in a release and require users attention, if the bug is minor no errata is needed.

Create a task¶

Create a task with Bug as tracker, mark it as Urgent and specify the current release branch in the custom field.

Write the fix¶

Update to the current release branch:

$ hg up release-x.y

Write a unique revision and use the following commit template.

topic: short description, closes #TASK_NUMBER

Explanation

Task: #TASK_NUMBER
Errata: YYYYMMDD

Export patch¶

Export the patch and sign it.

hg export > YYYYMMDD.patch
gpg --sign --armor YYYYMMDD.patch

Upload it in http://releases.malikania.fr/irccd/errata.

New release¶

Then, do a usual release as described in New release.

Wiki page¶

Create a new wiki page with the following template.

See template See template

h1. Errata YYYYMMDD

*Topic*: 
*Category*: As specified in tasks
*Corrected*: [[Version-x-y-z|x.y.z]] (or revision r???)
*Affected versions*: [[Version-x-y-z|x.y.z]]
*Task*: #???

h1. Background

Short explanation about the feature/context.

h1. Problem

Short description about the problem.

h1. Solution

Upgrade to a newer version if applicable or apply one of the following fixes:

h2. Using Mercurial

If you don't have a local copy:

<pre>
hg clone -u release-x.y http://hg.malikania.fr/irccd
</pre>

If you already have a local copy:

<pre>
cd /path/to/irccd
hg pull
hg up release-x.y
</pre>

And install new version of irccd.

h2. Using patch

Download the following patch:

* http://releases.malikania.fr/irccd/errata/YYYYMMDD.patch
* http://releases.malikania.fr/irccd/errata/YYYYMMDD.patch.asc

Apply it:

<pre>
cd /path/to/irccd/
patch -p1 < /path/to/YYYYMMDD.patch
</pre>

Files (0)

Updated by David Demelier over 3 years ago · 6 revisions

Project

General

Profile

irccd