TaxonomicEditorRelease » History » Version 36
Andreas Kohlbecker, 10/24/2012 11:37 AM
1 | 1 | Niels Hoffmann | |
---|---|---|---|
2 | 6 | Niels Hoffmann | |
3 | |||
4 | |||
5 | 1 | Niels Hoffmann | # Taxonomic Editor Release |
6 | |||
7 | |||
8 | 5 | Niels Hoffmann | The Taxonomic Editor is using eclipse tycho for integrating the OSGI build process into maven. Unfortunately the maven release plugin is not yet working with eclipse tycho (version 0.13) . |
9 | 1 | Niels Hoffmann | |
10 | This document explains all steps necessary to create a new release of the Taxonomic Editor. It is desirable to automate this process (see #xxxx). |
||
11 | |||
12 | 6 | Niels Hoffmann | |
13 | {{>toc}} |
||
14 | |||
15 | |||
16 | |||
17 | |||
18 | 7 | Niels Hoffmann | |
19 | ---- |
||
20 | 1 | Niels Hoffmann | |
21 | |||
22 | 3 | Niels Hoffmann | ## Prerequisites |
23 | 1 | Niels Hoffmann | |
24 | |||
25 | 9 | Lorna Morris | 1. Make sure that all relevant changes have been merged from the SNAPSHOT development branch into the trunk so the trunk can be used to make the release |
26 | |||
27 | 19 | Andreas Müller | 1. Lock the current SNAPSHOT branch so that no more commits can be made. In a fresh checkout you can lock the whole directory in zsh with |
28 | 1 | Niels Hoffmann | |
29 | 19 | Andreas Müller | ~~~ |
30 | 20 | Andreas Müller | svn lock <root>/**/*(.) |
31 | 1 | Niels Hoffmann | ~~~ |
32 | 21 | Andreas Müller | in bash with |
33 | 1 | Niels Hoffmann | |
34 | 21 | Andreas Müller | <pre> |
35 | |||
36 | find <root> -type f | xargs svn lock |
||
37 | |||
38 | </pre> |
||
39 | |||
40 | 31 | Andreas Müller | |
41 | or by using Tortoise Lock. |
||
42 | |||
43 | |||
44 | 3 | Niels Hoffmann | 1. There has to be a released cdmlib version (no snapshot), which the Taxonomic Editor depends on |
45 | 1 | Niels Hoffmann | |
46 | |||
47 | 3 | Niels Hoffmann | |
48 | |||
49 | ## Adapting cdmlib version |
||
50 | |||
51 | 30 | Andreas Müller | 1. In taxeditor-parent's pom.xml, change ONLY the version number of cdmlib (cdmlib.version) to the desired version e.g. from 3.0.9-SNAPSHOT to 3.0.10-SNAPSHOT (Note while 3.0.11 release: why change to 3.0.10-SNAPSHOT. Don't we want to have 3.0.9 as base, change to 3.0.10-SNAPSHOT later (TaxonomicEditorRelease#Bumptrunktonewversion) |
52 | 3 | Niels Hoffmann | |
53 | 36 | Andreas Kohlbecker | 1. remove old jars |
54 | |||
55 | ~~~ |
||
56 | rm eu.etaxonomy.taxeditor.cdmlib/lib/cdmlib-*.jar |
||
57 | ~~~ |
||
58 | 32 | Andreas Müller | 1. In eu.etaxonomy.taxditor.cdmlib, `mvn validate` to let maven copy the desired cdmlib jars into into eu.etaxonomy.taxeditor.cdmlib/lib directory. |
59 | 3 | Niels Hoffmann | |
60 | 36 | Andreas Kohlbecker | ~~~ |
61 | mvn validate |
||
62 | ~~~ |
||
63 | 3 | Niels Hoffmann | 1. Adapt the classpath to includethe desired cdmlib version in eu.etaxonomy.taxeditor.cdmlib |
64 | |||
65 | 1. Open MANIFEST.MF in 'Plugin Manifest Editor' |
||
66 | |||
67 | 1. Select 'Runtime' tab |
||
68 | |||
69 | 1. In the "Classpath" section, remove the entries for cdmlib |
||
70 | |||
71 | 10 | Lorna Morris | 1. Add the cdmlib jars with the desired version (these were copied into eu.etaxonomy.taxeditor.cdmlib/lib by the mvn validate step) |
72 | 3 | Niels Hoffmann | |
73 | |||
74 | |||
75 | ### Setting the release version number |
||
76 | |||
77 | 10 | Lorna Morris | Bump the version number to <version>.BUILDQUALIFIER, e.g. 3.0.10-RELEASE. From taxeditor-parent execute (replacing the <version> with the release number and replacing the BUILDQUALIFIER with a timestamp e.g. 3.0.10.201205251209: |
78 | 3 | Niels Hoffmann | |
79 | 17 | Andreas Müller | |
80 | 28 | Andreas Müller | NOTE: Test if -DnewVersion=3.0.10.RELEASE works. -> But probably we want to have timestamp as this is according to other eclipse plugin versioning conventions. |
81 | 17 | Andreas Müller | |
82 | |||
83 | 3 | Niels Hoffmann | ~~~ |
84 | mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=<version>.BUILDQUALIFIER |
||
85 | ~~~ |
||
86 | |||
87 | 10 | Lorna Morris | The outcome of running this command is that the version numbers in poms and MANIFEST.MF files have been changed. |
88 | 3 | Niels Hoffmann | |
89 | |||
90 | 1 | Niels Hoffmann | Attention: This procedure did not work for the _eu.etaxonomy.taxeditor.product_ file in the eu.etaxonomy.taxeditor project and the version number change had to be added manually (2012-02-07), we also changed it manually for the 3.0.10 release on 25.05.2012. |
91 | 28 | Andreas Müller | |
92 | |||
93 | Test: What is taxeditor.version number for. It looks like it does not have any effect. It should be same as cdmlib.version put maybe we can also delete -> TEST |
||
94 | |||
95 | |||
96 | 3 | Niels Hoffmann | |
97 | |||
98 | |||
99 | ## Create products |
||
100 | |||
101 | |||
102 | You can create the products with |
||
103 | |||
104 | |||
105 | ~~~ |
||
106 | mvn package |
||
107 | ~~~ |
||
108 | 1 | Niels Hoffmann | |
109 | 22 | Andreas Müller | taxeditor parent. |
110 | |||
111 | |||
112 | 5 | Niels Hoffmann | * The created products reside in eu.etaxonomy.taxeditor/target |
113 | |||
114 | 12 | Lorna Morris | * The packages should be moved to a folder with the name of the unqualified version (e.g. 3.0.10) in http://wp5.e-taxonomy.eu/download/taxeditor/ located under /var/www/download |
115 | 5 | Niels Hoffmann | |
116 | * Update the _stable_ symbolic link to point to the new folder |
||
117 | 3 | Niels Hoffmann | |
118 | 1 | Niels Hoffmann | |
119 | |||
120 | ## Create tag for release |
||
121 | 3 | Niels Hoffmann | |
122 | |||
123 | 1 | Niels Hoffmann | Commit the changes and create a tag with the release version number in http://dev.e-taxonomy.eu/svn/tags/taxeditor/release/ |
124 | 10 | Lorna Morris | |
125 | |||
126 | 4 | Niels Hoffmann | |
127 | 1 | Niels Hoffmann | ## Bump trunk to new version |
128 | 29 | Andreas Müller | |
129 | |||
130 | 30 | Andreas Müller | NOTE: if not yet set to next SNAPSHOT version number you may now increase cdmlib version to next number as described in [[TaxonomicEditorRelease]]#Adaptingcdmlibversion |
131 | 1 | Niels Hoffmann | |
132 | |||
133 | 4 | Niels Hoffmann | Update the version number to <version+1>-SNAPSHOT. From taxeditor-parent execute: |
134 | 1 | Niels Hoffmann | |
135 | 4 | Niels Hoffmann | ~~~ |
136 | mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=<version+1>-SNAPSHOT |
||
137 | ~~~ |
||
138 | 1 | Niels Hoffmann | |
139 | 4 | Niels Hoffmann | |
140 | 12 | Lorna Morris | Attention: This procedure did not work for the _eu.etaxonomy.taxeditor.product_ file in the eu.etaxonomy.taxeditor project and the version number change had to be added manually (2012-02-07), we also changed it manually to 3.0.11-SNAPSHOT on 25.05.2012. Edit the parent pom manually with 3.0.11-SNAPSHOT in 3 places. |
141 | 4 | Niels Hoffmann | |
142 | |||
143 | 23 | Andreas Müller | Commit the changes. |
144 | 4 | Niels Hoffmann | |
145 | 23 | Andreas Müller | |
146 | |||
147 | 1 | Niels Hoffmann | ## Create new development branch |
148 | |||
149 | |||
150 | 12 | Lorna Morris | 1. In eu.etaxonomy.taxditor.cdmlib, `mvn validate` to let maven copy the desired cdmlib jars. |
151 | |||
152 | 26 | Andreas Müller | 1. Adapt the classpath to include the desired cdmlib version in eu.etaxonomy.taxeditor.cdmlib |
153 | 12 | Lorna Morris | |
154 | 15 | Lorna Morris | 1. Open MANIFEST.MF in 'Plugin Manifest Editor' |
155 | 12 | Lorna Morris | |
156 | 15 | Lorna Morris | 1. Select 'Runtime' tab |
157 | 12 | Lorna Morris | |
158 | 1 | Niels Hoffmann | 1. In the "Classpath" section, remove the entries for cdmlib |
159 | |||
160 | 1. Add the cdmlib jars with the desired version (e.g. 3.0.11-SNAPSHOT jars). |
||
161 | 33 | Andreas Müller | |
162 | |||
163 | Create a new branch named <version+1>-SNAPSHOT in http://dev.e-taxonomy.eu/svn/branches/taxeditor/ (e.g. use Tortoise SVN to create branch/tag and set the URL to http://dev.e-taxonomy.eu/svn/branches/taxeditor/3.0.11-SNAPSHOT). |
||
164 | |||
165 | Question: Branch from trunk or from dev-branch? (23.7.2012) |
||
166 | 34 | Andreas Müller | |
167 | |||
168 | |||
169 | ## Post release tasks |
||
170 | |||
171 | |||
172 | 35 | Andreas Müller | Don't forget to install on ulteo (TaxonomicEditorUpdateOnUlteo) |