TaxonomicEditorRelease » History » Version 40
Cherian Mathew, 09/19/2013 11:18 AM
1 | 40 | Cherian Mathew | [|_This page has been deprecated for a newer version named [TaxonomicEditorDeployment TaxonomicEditorDeployment]]_ |
---|---|---|---|
2 | 6 | Niels Hoffmann | |
3 | |||
4 | 1 | Niels Hoffmann | # Taxonomic Editor Release |
5 | |||
6 | |||
7 | 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) . |
8 | 1 | Niels Hoffmann | |
9 | This document explains all steps necessary to create a new release of the Taxonomic Editor. It is desirable to automate this process (see #xxxx). |
||
10 | |||
11 | 6 | Niels Hoffmann | |
12 | {{>toc}} |
||
13 | |||
14 | |||
15 | |||
16 | |||
17 | 7 | Niels Hoffmann | |
18 | ---- |
||
19 | 1 | Niels Hoffmann | |
20 | |||
21 | 3 | Niels Hoffmann | ## Prerequisites |
22 | 1 | Niels Hoffmann | |
23 | |||
24 | 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 |
25 | |||
26 | 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 |
27 | 1 | Niels Hoffmann | |
28 | 19 | Andreas Müller | ~~~ |
29 | 20 | Andreas Müller | svn lock <root>/**/*(.) |
30 | 1 | Niels Hoffmann | ~~~ |
31 | 21 | Andreas Müller | in bash with |
32 | 1 | Niels Hoffmann | |
33 | 21 | Andreas Müller | <pre> |
34 | |||
35 | find <root> -type f | xargs svn lock |
||
36 | |||
37 | </pre> |
||
38 | |||
39 | 31 | Andreas Müller | |
40 | or by using Tortoise Lock. |
||
41 | |||
42 | |||
43 | 3 | Niels Hoffmann | 1. There has to be a released cdmlib version (no snapshot), which the Taxonomic Editor depends on |
44 | 1 | Niels Hoffmann | |
45 | |||
46 | 3 | Niels Hoffmann | |
47 | |||
48 | ## Adapting cdmlib version |
||
49 | |||
50 | 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) |
51 | 3 | Niels Hoffmann | |
52 | 36 | Andreas Kohlbecker | 1. remove old jars |
53 | |||
54 | ~~~ |
||
55 | rm eu.etaxonomy.taxeditor.cdmlib/lib/cdmlib-*.jar |
||
56 | ~~~ |
||
57 | 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. |
58 | 3 | Niels Hoffmann | |
59 | 36 | Andreas Kohlbecker | ~~~ |
60 | mvn validate |
||
61 | ~~~ |
||
62 | 3 | Niels Hoffmann | 1. Adapt the classpath to includethe desired cdmlib version in eu.etaxonomy.taxeditor.cdmlib |
63 | |||
64 | 37 | Andreas Kohlbecker | 1. Refresh the eclipse workspace (F5) |
65 | |||
66 | 3 | Niels Hoffmann | 1. Open MANIFEST.MF in 'Plugin Manifest Editor' |
67 | |||
68 | 1. Select 'Runtime' tab |
||
69 | |||
70 | 1. In the "Classpath" section, remove the entries for cdmlib |
||
71 | |||
72 | 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) |
73 | 3 | Niels Hoffmann | |
74 | |||
75 | |||
76 | ### Setting the release version number |
||
77 | |||
78 | 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: |
79 | 3 | Niels Hoffmann | |
80 | 17 | Andreas Müller | |
81 | 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. |
82 | 17 | Andreas Müller | |
83 | |||
84 | 3 | Niels Hoffmann | ~~~ |
85 | mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=<version>.BUILDQUALIFIER |
||
86 | ~~~ |
||
87 | |||
88 | 10 | Lorna Morris | The outcome of running this command is that the version numbers in poms and MANIFEST.MF files have been changed. |
89 | 3 | Niels Hoffmann | |
90 | |||
91 | 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. |
92 | 28 | Andreas Müller | |
93 | |||
94 | 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 |
||
95 | |||
96 | |||
97 | 3 | Niels Hoffmann | |
98 | |||
99 | |||
100 | ## Create products |
||
101 | |||
102 | |||
103 | You can create the products with |
||
104 | |||
105 | |||
106 | ~~~ |
||
107 | mvn package |
||
108 | ~~~ |
||
109 | 1 | Niels Hoffmann | |
110 | 22 | Andreas Müller | taxeditor parent. |
111 | |||
112 | |||
113 | 5 | Niels Hoffmann | * The created products reside in eu.etaxonomy.taxeditor/target |
114 | |||
115 | 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 |
116 | 5 | Niels Hoffmann | |
117 | * Update the _stable_ symbolic link to point to the new folder |
||
118 | 3 | Niels Hoffmann | |
119 | 1 | Niels Hoffmann | |
120 | |||
121 | ## Create tag for release |
||
122 | 3 | Niels Hoffmann | |
123 | |||
124 | 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/ |
125 | 10 | Lorna Morris | |
126 | |||
127 | 4 | Niels Hoffmann | |
128 | 1 | Niels Hoffmann | ## Bump trunk to new version |
129 | 29 | Andreas Müller | |
130 | |||
131 | 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 |
132 | 1 | Niels Hoffmann | |
133 | |||
134 | 4 | Niels Hoffmann | Update the version number to <version+1>-SNAPSHOT. From taxeditor-parent execute: |
135 | 1 | Niels Hoffmann | |
136 | 4 | Niels Hoffmann | ~~~ |
137 | mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=<version+1>-SNAPSHOT |
||
138 | ~~~ |
||
139 | 1 | Niels Hoffmann | |
140 | 4 | Niels Hoffmann | |
141 | 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. |
142 | 4 | Niels Hoffmann | |
143 | |||
144 | 23 | Andreas Müller | Commit the changes. |
145 | 4 | Niels Hoffmann | |
146 | 23 | Andreas Müller | |
147 | |||
148 | 1 | Niels Hoffmann | ## Create new development branch |
149 | |||
150 | |||
151 | 12 | Lorna Morris | 1. In eu.etaxonomy.taxditor.cdmlib, `mvn validate` to let maven copy the desired cdmlib jars. |
152 | |||
153 | 26 | Andreas Müller | 1. Adapt the classpath to include the desired cdmlib version in eu.etaxonomy.taxeditor.cdmlib |
154 | 12 | Lorna Morris | |
155 | 15 | Lorna Morris | 1. Open MANIFEST.MF in 'Plugin Manifest Editor' |
156 | 12 | Lorna Morris | |
157 | 15 | Lorna Morris | 1. Select 'Runtime' tab |
158 | 12 | Lorna Morris | |
159 | 1 | Niels Hoffmann | 1. In the "Classpath" section, remove the entries for cdmlib |
160 | |||
161 | 1. Add the cdmlib jars with the desired version (e.g. 3.0.11-SNAPSHOT jars). |
||
162 | 33 | Andreas Müller | |
163 | |||
164 | 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). |
||
165 | |||
166 | Question: Branch from trunk or from dev-branch? (23.7.2012) |
||
167 | 34 | Andreas Müller | |
168 | |||
169 | 39 | Cherian Mathew | |
170 | ## Update Tickets / Release Information |
||
171 | 38 | Cherian Mathew | |
172 | Close the TaxEditor milestone, move all remaining tickets to the next release milestone (offered as option when closing the milestone) and finally update the http://dev.e-taxonomy.eu/trac/wiki/CdmPlatformRoadmap page. |
||
173 | |||
174 | |||
175 | 34 | Andreas Müller | |
176 | ## Post release tasks |
||
177 | |||
178 | |||
179 | 35 | Andreas Müller | Don't forget to install on ulteo (TaxonomicEditorUpdateOnUlteo) |