release.rst 2.64 KB
Newer Older
fv3rdugo's avatar
fv3rdugo committed
1
2
3
Steps to release
================

Francesc Guasch's avatar
Francesc Guasch committed
4
5
6
Create a branch
---------------

Francesc Guasch's avatar
Francesc Guasch committed
7
8
9
10
Name the branch following the guidelines of semantic versioning http://semver.org/:

MAJOR.MINOR.PATCH, increment the:

Francesc Guasch's avatar
Francesc Guasch committed
11
12
13
* MAJOR version when you make incompatible API changes,
* MINOR version when you add functionality in a backwards-compatible manner, and
* PATCH version when you make backwards-compatible bug fixes.
Francesc Guasch's avatar
Francesc Guasch committed
14
15


Francesc Guasch's avatar
Francesc Guasch committed
16
17
18
::

    $ git checkout master
19
20
    $ git checkout -b release/0.2.2
    $ git push --set-upstream origin release/0.2.2
Francesc Guasch's avatar
Francesc Guasch committed
21

fv3rdugo's avatar
fv3rdugo committed
22
Draft
Fernando Verdugo's avatar
Fernando Verdugo committed
23
-----
fv3rdugo's avatar
fv3rdugo committed
24
25

Draft the release
Fernando Verdugo's avatar
Fernando Verdugo committed
26
~~~~~~~~~~~~~~~~~
fv3rdugo's avatar
fv3rdugo committed
27

Francesc Guasch's avatar
Francesc Guasch committed
28
This step should be done at the very beginning of planning. If you already did it, skip it now.
29

fv3rdugo's avatar
fv3rdugo committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
At code -> releases draft a new release

-  tag version : v0.2.2
-  release title : v0.2.2

Create the milestone
--------------------

At the *issues* section , create a milestone. Name it like the tag
version: 0.2.2. There must be a way to link it to the *tag* , I just
don't know how.

Create issues
-------------

Assign issues to the milestone

Close
Fernando Verdugo's avatar
Fernando Verdugo committed
48
-----
fv3rdugo's avatar
fv3rdugo committed
49
50

Close the milestone
Fernando Verdugo's avatar
Fernando Verdugo committed
51
~~~~~~~~~~~~~~~~~~~
fv3rdugo's avatar
fv3rdugo committed
52
53
54
55
56
57
58
59

Check the milestone has no open issues and close it.

Update the authors
------------------

::

Francesc Guasch's avatar
Francesc Guasch committed
60
    $ git checkout 0.2.2
fv3rdugo's avatar
fv3rdugo committed
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
    $ cd templates/bootstrap/
    $ ./get_authors.sh

It will create a file *authors.html.ep*, review it and commit it.

::

    $ git commit authors.html.ep
    $ cd ../..

Update the release number
-------------------------

In Ravada.pm
~~~~~~~~~~~~

Modify *lib/Ravada.pm* around line 5:

::

    our $VERSION = '0.2.5';

Modify the Changelog
--------------------

Check the last issues closed for this milestone and add them to the
Changelog file:

::

91
    $ git checkout release/0.2.2
fv3rdugo's avatar
fv3rdugo committed
92
93
94
95
96
97
98
99
100
101
102
103
    $ gvim Changelog.md
    $ git commit -a



Close the release
-----------------

Make sure the target is the same as the branch, not the master. Close
the release at:

-  Close the Milestone
Francesc Guasch's avatar
Francesc Guasch committed
104
-  Publish the Release
fv3rdugo's avatar
fv3rdugo committed
105
106

Release binary
Fernando Verdugo's avatar
Fernando Verdugo committed
107
--------------
fv3rdugo's avatar
fv3rdugo committed
108
109

Debian
Fernando Verdugo's avatar
Fernando Verdugo committed
110
~~~~~~
fv3rdugo's avatar
fv3rdugo committed
111
112
113
114
115
116

Create the *debian* package.

::

    $ fakeroot ./deb/debianize.pl
Fernando Verdugo's avatar
Fernando Verdugo committed
117
    $ lintian ravada_0.2.2_all.deb
fv3rdugo's avatar
fv3rdugo committed
118
119
120
121
122

Upload the file to our repo and change the number at:

::

Francesc Guasch's avatar
Francesc Guasch committed
123
    http://ravada.readthedocs.io/en/latest/docs/INSTALL.html
fv3rdugo's avatar
fv3rdugo committed
124

Francesc Guasch's avatar
Francesc Guasch committed
125
126
    $ git checkout gh-pages
    $ gvim docs/docs/INSTALL.md
Francesc Guasch's avatar
Francesc Guasch committed
127
    $ gvim docs/docs/res/ravada_installer.sh
Francesc Guasch's avatar
Francesc Guasch committed
128
    $ gvim index.html
fv3rdugo's avatar
fv3rdugo committed
129
130
131
    $ git commit -a
    $ git push

Francesc Guasch's avatar
Francesc Guasch committed
132
133
Install it
----------
Francesc Guasch's avatar
Francesc Guasch committed
134
135
136
137
In a test machine, upgrade ravada following:

    http://ravada.readthedocs.io/en/latest/docs/update.html
    
Francesc Guasch's avatar
Francesc Guasch committed
138
139
140
141
In a fresh machine, install it following the whole process:

    http://ravada.readthedocs.io/en/latest/docs/INSTALL.html

fv3rdugo's avatar
fv3rdugo committed
142
Publish
Fernando Verdugo's avatar
Fernando Verdugo committed
143
-------
fv3rdugo's avatar
fv3rdugo committed
144
145

-  Tweet it
Francesc Guasch's avatar
Francesc Guasch committed
146
-  Mail it in google group ravada@groups.google.com
Francesc Guasch's avatar
Francesc Guasch committed
147
-  Change the release in branch master README.md