Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 Contains instructions to perform various release steps in the [[Release Plans>>ReleasePlans.WebHome]].
7 {{id name="HInitialCLIRRcheck"/}}
9 = Initial Backward Compatibility Check =
11 This initial step checks if the previous release cycle, or more recent bugfix releases done since, have properly set the ##xwiki.compatibility.previous.version## property in the [[top level POM of ##xwiki-commons##>>]] (for the branch you are currently releasing).
13 For example, if the current release to be made is for ##4.2-milestone-3## and, in the meanwhile, there have been released bugfix versions for 4.1 (4.1.4 being the latest released), you need to ensure that the value for ##xwiki.compatibility.previous.version## is ##4.1.4##.
15 = Verify JIRA issue =
17 If there are opened JIRA issues for the version you are currently releasing (##fixVersion## is set to the current release), you have two options:
19 1. The issue has no code committed yet (Commits tab shows nothing). In this case, you need to push the issue to the next development version. (e.g. ##fixVersion## = 6.3-milestone-1 will be moved to ##fixVersion## = 6.3-milestone-2)
20 1. There is some code already committed (Commits tab is not empty). In this case, you need to contact the assigned developer of the issue and find out if the committed code is complete:
21 11. If the code is complete, you can close the issue (or ask the dev to do it)
22 11. If the code is not complete, you can close the issue and ask the dev to create a new issue for the remaining work to be done for the next version.
24 In all cases, all opened issues must be closed before the release can be done.
26 = Verify issues with commits =
28 Such open issues may exist because the wrong issue key was used when committing, the existing commits are just trying to fix a test or adding extra logging (and not affecting the runtime) while the problem has not been addressed, it's a commit in a feature branch, etc. You need to ignore these false positives and detect any issue that has actual work done on it that is relevant for this release, close it and assign it the correct fix version so that it's properly counted in the release notes.
30 Note: The JIRA query is not perfect yet as we [[cannot query on the commit update date>>]]. Thus FTM you'll need to review each issue listed and verify if the issue should be closed or if it's a false positive.
32 = Log on Release machine =
34 {{code language="sh"}}
35 # Get on the maven CI master machine
36 [email protected]:~$ ssh [email protected]
38 # Get on the agent machine
39 [email protected]:~$ release
40 {{/code}}
42 = Set up your identity =
44 == The first time ==
46 * [[Configure your Github profile to add the SSH key of the agent>>]] so that the commits can be pushed to Github with your user (To get the agent SSH key, do {{code language="sh"}}cat ~/.ssh/{{/code}}). To verify it works, do the following on the agent machine: {{code language="sh"}}ssh -T [email protected]{{/code}}. It should reply with ##Hi <your user id>! You've successfully authenticated, but GitHub does not provide shell access.##.
47 * [[Create your own GPG key>>]] if you don't already have one: {{code language="sh"}}gpg --gen-key{{/code}}
48 * [[Publish your public GPG key>>,IntegrateMavenandGPG-DistributeYouPublicKey]], if you have not already done so: {{code language="sh"}}gpg --keyserver hkp:// --send-key <keyID>{{/code}}
49 * Import your GPG key:
50 ** On your local computer run: {{code language="sh"}}gpg --list-secret-keys{{/code}}
51 ** Export your key in a ##secret.key## file: {{code language="sh"}}gpg --export-secret-keys «keyID» > secret.key{{/code}} where ##keyID## is the hexadecimal string on the ##sec## line (either 8 char long or 40 char long)
52 ** Copy the ##secret.key## file to the agent machine (you may need to copy to first and then to agent-1-1)
53 *** From your local computer, upload the key to {{code language="sh"}}scp secret.key [email protected]:/home/maven{{/code}}
54 *** From (/home/maven): {{code language="sh"}}scp -i ~/.ssh/releaser_ssh secret.key [email protected]:/home/releaser/<yourname>.gpgkey{{/code}} (give it a name)
55 **** The key can be stored on the agent, since it's password protected, so that you don't have to upload it next time, and just re-import it.
56 **** TODO: find out how we can keep the keys imported and tell maven which one to use during the release.
57 *** Remove the key from after you have uploaded it to agent-1-1: {{code language="sh"}}rm secret.key{{/code}}
58 ** On the agent machine, run {{code language="sh"}}gpg --import <yourname>.gpgkey{{/code}}
59 * You need to have a ##.gitconfig.<yourusername>## file. You can do that by copying one of the existing ##gitconfig## file
60 * Make sure your ##gitconfig## file has the key ##signingkey## in the ##[user]## section (the value is your key id which you can get with {{code language="sh"}}gpg --list-secret-keys{{/code}}).
61 * Copy your ##.gitconfig.<yourusername>## file as the main ##gitconfig## file: {{code language="sh"}}cp .gitconfig.<yourusername> .gitconfig{{/code}}
63 == The other times ==
65 * [[Configure your Github profile to add the SSH key of the agent>>]] so that the commits can be pushed to Github with your user (To get the agent SSH key, do {{code language="sh"}}cat ~/.ssh/{{/code}}). To verify it works, do the following on the agent machine: {{code language="sh"}}ssh -T [email protected]{{/code}}. It should reply with ##Hi <your user id>! You've successfully authenticated, but GitHub does not provide shell access.##.
66 * Make sure previous release manager did not left his GPG key
67 {{code language="sh"}}gpg --delete-secret-and-public-keys $(gpg --list-secret-keys | grep ^sec -A 1 | tail -n 1 | awk '{ print $1 }'){{/code}}
68 * Import your GPG key, run {{code language="sh"}}gpg --import <yourname>.gpgkey{{/code}}
69 ** If you did not leave your secret key file on the agent machine, you have to re-upload it (see [[The first time>>||anchor="HThefirsttime"]] section above).
70 * Copy your ##.gitconfig.<yourusername>## file as the main ##gitconfig## file: {{code language="sh"}}cp .gitconfig.<yourusername> .gitconfig{{/code}}
72 === Script to automatize this step ===
74 1. Put this script on your local machine.
75 1. Replace the ##USER_NAME## variable.
76 1. Make sure you have exported your secret key in a file called ##secret.key## in your user directory.
77 1. Don't forget to give execution right to the file.
78 1. Execute and enjoy!
80 {{code language="sh"}}
81 #!/bin/bash
83 USER_NAME='gdelhumeau'
85 function log {
86 ## Colors
87 RESET_TEXT_COLORS='\033[0m'
88 GREEN_TEXT='\033[1;32m'
89 BLACK_BACKGROUND='\033[40m'
92 }
94 log "Copy secret key to the maven machine"
95 scp ~/secret.key "[email protected]:/home/maven/${USER_NAME}.key"
97 log "Put it on the agent1-1"
98 ssh [email protected] "scp /home/maven/${USER_NAME}.key a1-1:/home/hudsonagent"
100 log "Delete it from"
101 ssh [email protected] "rm /home/maven/${USER_NAME}.key"
103 log "Import the key in agent1-1"
104 ssh [email protected] "ssh a1-1 'gpg --import /home/hudsonagent/${USER_NAME}.key'"
106 log "Delete it from agent1-1"
107 ssh [email protected] "ssh a1-1 'rm /home/hudsonagent/${USER_NAME}.key'"
109 log "Copy gitconfig"
110 ssh [email protected] "ssh a1-1 'cp /home/hudsonagent/.gitconfig.${USER_NAME} /home/hudsonagent/.gitconfig'"
112 log "Display agent1-1 SSH key (to put on"
113 printf "\033[0;91m\033[0;100m"
114 ssh [email protected] "ssh a1-1 'cat /home/hudsonagent/.ssh/'"
116 log "Connect to hudsonagent"
117 ssh -tt [email protected] "ssh -tt a1-1"
118 {{/code}}
120 = Update Release scripts =
122 {{code language="sh"}}
123 # Update the release script
124 [email protected]:~$ cd xwiki-dev-tools ; git pull --rebase ; cd ..
125 {{/code}}
127 {{info}}
128 Do a ##git status## to verify that there are not any committed but not pushed stuff lying around...
129 {{/info}}
131 = Configure the Java Version =
133 Depending on which branch you are releasing from you may have to use a different Java version than what is used on master. To change the Java version you need to remove the "java" symbolic link from the home folder and recreate it to point to the "javaX" folder that corresponds to the Java version you have to use.
134 Right now only two versions of Java are installed on the release agent: Java8 and Java11, but it might evolve. Path of the java versions are available with the environment variable ##$JAVA_XX_PATH##.
136 {{code language="sh"}}
137 # Change the Java version
138 [email protected]:~$ rm java
139 [email protected]:~$ ln -s $JAVA_8_PATH java
140 # See if the change has been taken into account.
141 [email protected]:~$ java -version
142 {{/code}}
144 = Update Translations =
146 {{warning}}
147 When you release a .x version (bug fix release), be very careful when you update translations because the new ones might concern new stuff introduced in the master branch. The issue is that the translations platform does not support branches (translations are coming from master).
148 {{/warning}}
150 For a **release candidate**, the translations were already merged (when the Pull Requests were accepted) into the master branch which you have just forked.
152 For a **final version**, there may be translations added since the RC that we need to integrate. Perform the following steps:
154 * Move to ##xwiki-trunks##:(((
155 {{code language="sh"}}
156 [email protected]:~$ cd releases/xwiki-trunks/
157 {{/code}}
158 )))
159 * Run the update goal of the script with your branch (e.g. stable-10.5.x):(((
160 {{code language="sh"}}
161 [email protected]:~/releases/xwiki-trunks$ ~/xwiki-dev-tools/weblate-scripts/ update stable-10.5.x
162 {{/code}}
163 )))
164 * Review the changes for anything amiss.
165 ** You need to go through each project (##xwiki-commons##, ##xwiki-rendering##, ##xwiki-platform##)
166 ** Do a {{code}}git status{{/code}} to spot changes.
167 *** Do a {{code}}git diff --cached{{/code}} and visually review modified translation keys and spot problems (like spam). Do not spend too much time here, since major issues should have been reviewed by the committer that merged the Pull Request, a quick scan is enough to spot obvious problems.
168 *** No need to do a {{code}}git add{{/code}} at this point since it will be done for all projects below.
169 * Push / commit the translation changes on the branch of the version you are releasing (e.g. stable-10.5.x):(((
170 {{code language="sh"}}
171 [email protected]:~/releases/xwiki-trunks$ ~/xwiki-dev-tools/weblate-scripts/ push stable-10.5.x
172 {{/code}}
173 )))
175 = Compute list of updated languages =
177 Collect the **list of updated languages** to publish in the Release Notes:
179 * ##cd## to each repository (##xwiki-commons##, ##xwiki-rendering##, ##xwiki-platform##)
180 * Run the script to list all relevant modified translation files since the previously released **final** version and generate the list of modified languages (notice the usage of the ##~-~-diff## parameter to help you decide if a translation language should be counted or not, see below for more details):(((
181 {{code language="bash"}}
182 ## start_commit end_commit [options]
184 ## Example when releasing a final version (e.g. 10.7):
185 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ ~/xwiki-dev-tools/weblate-scripts/ xwiki-commons-10.6.1 stable-10.7.x --diff | less -r
186 ## Example when releasing a RC version (e.g. 10.7RC1):
187 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ ~/xwiki-dev-tools/weblate-scripts/ xwiki-commons-10.6.1 xwiki-commons-10.7-rc-1 --diff | less -r
189 ## Other examples on some already released versions (in case the need arises):
190 [email protected]:~/releases/xwiki-trunks/xwiki-rendering$ ~/xwiki-dev-tools/weblate-scripts/ xwiki-rendering-10.3 xwiki-rendering-10.4 --diff | less -r
191 [email protected]:~/releases/xwiki-trunks/xwiki-platform$ ~/xwiki-dev-tools/weblate-scripts/ xwiki-platform-10.3 xwiki-platform-10.4 --diff | less -r
192 {{/code}}
193 )))
194 * Merge the list of updated language codes across all the repositories (from the output of the commands above) and update the Release Notes in the ##Translations## section with these language codes.
195 ** Only count what should be counted:(((
196 {{error}}
197 Be careful to only count real translation changes. For example if Weblate reorder the translations but no new translation is added, the language should not be counted.
199 At the moment the script keeps all changes of the type `<start of line>key=value`, i.e. it discard comments for ex `#Missing someKey=someValue` is not counted.
201 Since it can be hard to figure out what are user changes when there are key renames, key deletions or key move, another way to view changes is to look at the [[Activity Stream on l10n for added or changed translations>>]].
203 {{/error}}
204 )))
205 ** Skip duplicates and sort the final list alphabetically.
207 {{warning}}
208 If the flag for a translation is missing, add it to [[xwiki:Macros.Language]].
209 {{/warning}}
211 = Build the release =
213 {{toc scope="local"/}}
215 {{info}}
216 Tip: running the release script will first ask you for your GPG key passphrase. If you mistype or enter a wrong passphrase, the release will fail to perform. You can test your passphrase locally running the following command :
218 {{code language="sh"}}echo "test" | gpg -o /dev/null --local-user <KEYID> -as - && echo "Passphrase is correct"{{/code}}
220 If for a reason or another you've made a mistake typing your passphrase in, you will need to delete (locally on the agent machine) the release branch and created tag before you can start over again.
221 {{/info}}
223 {{info}}
224 In general the answer to **What is the next SNAPSHOT version?** is ##<next version in that branch>-SNAPSHOT##. Here are some examples:
225 * when releasing ##10.10-rc-1## the answer is ##10.10-SNAPSHOT##
226 * when releasing ##10.10## the answer is ##10.10.1-SNAPSHOT##
227 * when releasing ##10.10.1## the answer is ##10.10.2-SNAPSHOT##
229 When releasing a ##Release Candidate## (e.g. 6.2-rc-1), make sure that, when asked **What is the next SNAPSHOT version?**, you do not increment the snapshot version (i.e. you answer **6.2-SNAPSHOT** instead of 6.3-SNAPSHOT or whatever suggestion you have). This is because the next step will ask you to create a stable branch where the final version (if this is the last RC we`re doing) will be released and there we need to keep the SNAPSHOT version to the current one.
231 If you have created the stable branch and are asked **What is the next master version?**, you will now increment the snapshot version (i.e. answer **6.3-SNAPSHOT**) so that the master branch can move to the next development version.
232 {{/info}}
234 {{info}}
235 Tip: Because the build process is a lenghty one (currently around 2 hours), it is a good idea to use the [[screen linux command>>]]. This is most helpful in case your Internet connection or electrical power drops. However, it is not in any way mandatory to use screen during the release.
236 {{/info}}
238 {{code language="sh"}}
239 # Perform the release from the release sources
240 [email protected]:~/releases/xwiki-trunks$ ~/
241 {{/code}}
243 == Restart the release ==
245 If the build failed or if you wish to release again, perform the following steps:
247 * Set the version that you're building, e.g. {{code language="sh"}}[email protected]:~/releases/xwiki-trunks$ export VERSION='4.2-milestone-3'{{/code}}
248 * Navigate to the repositories that failed to build (e.g. ##xwiki-platform##) and clean up. For example for ##xwiki-platform##:(((
249 {{code language="sh"}}
250 [email protected]:~/releases/xwiki-trunks$ cd xwiki-platform
251 [email protected]:~/releases/xwiki-trunks/xwiki-platform$ ~/
252 {{/code}}
253 )))
254 * Edit the script and comment out the previously successfully released repositories so that you don't release them again.(((
255 {{code language="sh"}}
256 [email protected]:~/releases/xwiki-trunks/xwiki-platform$ cd ..
257 [email protected]:~/releases/xwiki-trunks$ vim ~/
258 {{/code}}
260 Go to the end of the file and scroll up, until you reach this section:
262 {{code language="sh"}}
263 # Wrapper function that calls release_project for each XWiki project in order: commons, rendering, platform, enterprise, manager.
264 # This is the main function that is called when running the script.
265 function release_all() {
266 ...
267 {{/code}}
269 Inside this method, comment out the previously successful top level projects and leave uncommented the top level projects that still need to be released, including the one we are resuming from. In this example, we are resuming from ##xwiki-platform## but ##xwiki-commons## and ##xwiki-rendering## were already successfully released, so we are skipping them:
271 {{code language="sh"}}
272 ...
273 echo "*****************************"
274 echo -e "\033[1;32m Releasing xwiki-commons\033[0m"
275 echo "*****************************"
276 # release_project xwiki-commons
277 echo "*****************************"
278 echo -e "\033[1;32m Releasing xwiki-rendering\033[0m"
279 echo "*****************************"
280 # release_project xwiki-rendering
281 echo "*****************************"
282 echo -e "\033[1;32m Releasing xwiki-platform\033[0m"
283 echo "*****************************"
284 release_project xwiki-platform
285 ...
286 {{/code}}
287 )))
288 * Fix the build if need be (you won't need to fix anything if you just want to release again for example).
289 * Re-launch the script from ##/releases/xwiki-trunks## to resume from where we left off:(((
290 {{code language="sh"}}
291 [email protected]:~/releases/xwiki-trunks$ ~/
292 {{/code}}
293 )))
295 === If the release:prepare is good and you need to restart only the release:perform ===
297 {{warning}}
298 The instructions below are **not applicable for RC releases** (that involve working with other branches than ##master## and other additional operations). Would need additional steps to be complete, so it`s safer to just restart from the top level project that failed (i.e. rendering, platform, etc.).
299 {{/warning}}
301 Going even further with the resuming of a failed build, in the case of release:perform, we can resume from the actual failed module. To do so, we must make some additional temporary modifications to the release script, besides the one described above which isolates the script to release only the currently failed module.
303 {{warning}}
304 This method only applies to a **single failed project** at a time (e.g. xwiki-platform). Make sure all other projects are **commented out** in the ##release_all## method.
306 Do **not** run the ##~~/ command on the failed module because ##release:perform## needs that information to be able to resume. Also, remember to cleanup after finishing with the release of the project at hand.
307 {{/warning}}
309 Comment out the cleanup steps done in the ##release_project## method:
311 {{code language="sh"}}
312 function release_project() {
313 cd $1
314 # pre_cleanup
315 # update_sources
316 # check_branch
317 # create_release_branch
318 # pre_update_parent_versions
319 release_maven
320 post_update_parent_versions
321 push_release
322 ...
323 {{/code}}
325 Comment out the ##release:prepare## step in the ##release_maven## method and add the ##-rf group:artefactId## parameter inside the -Darguments="..." with the module you want to resume the release from. See an example below where we are resuming from ##org.xwiki.platform:xwiki-platform-distribution-war##.
327 {{code language="sh"}}
328 function release_maven() {
329 DB_PROFILE=hsqldb
331 echo -e "\033[0;32m* release:prepare\033[0m"
332 # mvn release:prepare -DpushChanges=false -DlocalCheckout=true -DreleaseVersion=${VERSION} -DdevelopmentVersion=${NEXT_SNAPSHOT_VERSION} -Dtag=${TAG_NAME} -DautoVersionSubmodules=true -Phsqldb,mysql,pgsql,derby,jetty,glassfish,legacy,integration-tests,office-tests,standalone -Darguments="-N ${TEST_SKIP}" ${TEST_SKIP} || exit -2
334 echo -e "\033[0;32m* release:perform\033[0m"
335 mvn release:perform -DpushChanges=false -DlocalCheckout=true -P${DB_PROFILE},jetty,legacy,integration-tests,office-tests,standalone ${TEST_SKIP} -Darguments="-P${DB_PROFILE},jetty,legacy,integration-tests,office-tests ${TEST_SKIP} -Dgpg.passphrase='${GPG_PASSPHRASE}' -Dxwiki.checkstyle.skip=true -rf org.xwiki.platform:xwiki-platform-distribution-war" -Dgpg.passphrase="${GPG_PASSPHRASE}" || exit -2
337 echo -e "\033[0;32m* Creating GPG-signed tag\033[0m"
338 ...
339 {{/code}}
341 Manually set the git tag name that will be used for GPG signing:
343 {{code language="sh"}}
344 ## The format is MODULE_NAME-VERSION. Modify accordingly.
345 export TAG_NAME="xwiki-platform-8.3-milestone-2"
346 {{/code}}
348 Run the release script to resume the release of the current project:
350 {{code language="sh"}}
351 [email protected]:~/releases/xwiki-trunks/xwiki-platform$ ~/
352 {{/code}}
354 {{warning}}
355 **Cleanup** the release script by removing the temporary changes described in this section. This applies if you want to proceed to the next project (e.g. xwiki-enterprise) where the release needs to be executed properly.
356 {{/warning}}
358 = Generate Code Contributors list =
360 {{info}}
361 * The following commands should be performed on the agent machine, after running the build (but can be run locally as well).
362 * If you're releasing a final version, also include the contributors for the RC.
363 {{/info}}
365 * Automatically, on the agent:(((
366 {{code language="bash"}}
367 ## <start_version> <end_version>
368 [email protected]:~/releases/xwiki-trunks$ ~/xwiki-dev-tools/xwiki-release-scripts/ 10.4 10.5-rc-1
369 {{/code}}
370 )))
371 * Manually (on the agent or locally, if the automatic option fails):
372 ** Collect the list of code contributors for this release by running the following command on each branch on each repository that has been released (##xwiki-commons##, ##xwiki-rendering##, ##xwiki-platform##):(((
373 {{code language="bash"}}
374 > git fetch --tags
375 > git log --pretty=format:"%an" <previousTag>..<nextTag> | sort -u
376 ## Example:
377 > git log --pretty=format:"%an" xwiki-commons-10.4..xwiki-commons-10.5-rc1 | sort -u
378 > git log --pretty=format:"%an" xwiki-rendering-10.4..xwiki-rendering-10.5-rc1 | sort -u
379 > git log --pretty=format:"%an" xwiki-platform-10.4..xwiki-platform-10.5-rc1 | sort -u
380 ## For **final versions**, always compare with the previous final, not with the previous RC:
381 > git log --pretty=format:"%an" xwiki-platform-10.4..xwiki-platform-10.5 | sort -u
382 {{/code}}
383 )))
384 * Try to remove duplicates and infrastructure users (like ##xwikirogci## or ##XWiki##) and sort alphabetically.
385 * Update the Release Notes in the Credits section with the contributors list.
387 = Handle Backward Compatibility Actions =
389 == Update Backward Compatibility in the release note ==
391 The Backward Compatibility report is automatically generated in the Release Notes page by the ##~{~{backwardCompatibilityReport134 version="<version>"/}}## macro which does the following:
393 * Gets the revapi ignores from the ##pom.xml## of ##xwiki-commons##, ##xwiki-rendering## and ##xwiki-platform## GitHub repositories and store them in an xobject in the Release Note page. If you wish to regenerate the content from GitHub just delete this xobject.
394 * Displays the ignores
396 {{info}}
397 If the XWiki version released is < 13.4RC1 then you need to use the old macro: ##~{~{backwardCompatiblityReportXml version="<version>"/}}##
398 {{/info}}
400 == Update the backward compatibility setup in the build ==
402 If you're releasing a **final or bugfix**, perform the following operations on the agent or on your local machine:
404 * (((
405 Automatically, on the agent:
407 (((
408 {{code}}
409 ## <new_version>
410 [email protected]:~/releases/xwiki-trunks$ ~/xwiki-dev-tools/xwiki-release-scripts/ 12.3
411 ...
412 ...
413 ...
414 Also update the [master] branch? (Only if new release version is 'bigger' than the existing one. Y for final, N for most bugfixes except bugfix of a very recent final) :
415 [y/N]
416 {{/code}}
417 )))
419 * When asked **Also update the [master] branch?**, only answer {{code}}y{{/code}} (##yes##) in one of these 2 cases, otherwise answer {{code}}N{{/code}} (##no##):(((
420 1. (common) if you are releasing a **final version** (e.g. 12.3, from stable-12.3.x that was recently created by the release candidate that was released 2 weeks ago) OR
421 1. (less common) if you are releasing a //bugfix version that would be "bigger"// than any existing version (e.g. 12.3 was just released, or even 12.3-rc-1, however, a critical bug was discovered and we quickly release the bugfix version ##12.3.1##. For this bugfix, you also need to update master, because it acts more like a final version than a bugfix and is 'bigger' than what was released until then.)
422 )))
423 )))
424 * Manually (on the agent or locally, if the automatic option fails):
425 ** Checkout ##master## for ##xwiki-commons## and edit the top level ##pom.xml## to update the ##xwiki.compatibility.previous.version##. Set the value to be your release you've just done.(((
426 {{code}}
427 ## Replace the previous version with the new version (e.g. 10.4 with 10.5).
428 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ git checkout master
429 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ sed -i 's/<xwiki.compatibility.previous.version>.*</<xwiki.compatibility.previous.version>10.5</' pom.xml
430 ## Double check that it has been updated
431 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ git diff
432 ## Commit and push
433 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ git commit -a -m "[release] Updated compatibility previous version to the one just released."
434 [email protected]:~/releases/xwiki-trunks/xwiki-commons$ git push origin master
435 {{/code}}
436 )))
437 ** On ##master##, you have to remove ignores from 3 locations and then commit & push the changes (##git commit -a -m "[Misc] Removed revapi ignores from the previous version"##):
438 *** ##xwiki-commons/xwiki-commons-core/pom.xml##
439 *** ##xwiki-rendering/pom.xml##
440 *** ##xwiki-platform/xwiki-platform-core/pom.xml##
441 *** If you are doing this on the agent, you can use ##nano## to open the files and use ##CTRL+W## to search for ##revapi##. Once you have found the JSON formatted ignores, select all the lines you want to delete by using ##CTRL+SHIFT+6## and press ##CTRL+K## to delete the selected lines. Exit the exitor with ##CTRL+X##, ##y##, ##ENTER## (when asked if the changes should be saved) and commit the changes for each repository.
442 ** Make sure the ##xwiki.compatibility.previous.version## value is changed also on the branch from where you've released, and that the ignores are cleaned too from the branch, since future releases (ex. 10.5.1) are final releases too.
444 = Clean up identity =
446 {{code language="sh"}}
447 # Git identity
448 [email protected]:~/releases/xwiki-trunks$ cd
449 [email protected]:~$ cp .gitconfig.default .gitconfig
451 # GPG key
452 [email protected]:~$ gpg --delete-secret-and-public-keys $(gpg --list-secret-keys | grep ^sec -A 1 | tail -n 1 | awk '{ print $1 }')
454 # Local changes to the release-scripts (, user/password in, etc.)
455 [email protected]:~$ cd xwiki-dev-tools
456 # Double check that you are not removing any improvement you have made to the release scripts that should be committed instead ;)
457 [email protected]:~/xwiki-dev-tools$ git status
458 [email protected]:~/xwiki-dev-tools$ git diff
459 [email protected]:~/xwiki-dev-tools$ git checkout .
460 {{/code}}
462 (!) Then don't forget to [[remove the Agent's SSH Key from your Github Account>>]].
464 {{id name="HGenerateCLIRRReport"/}}
466 {{id name="HGenerateBackwardCompatibilityReport"/}}
468 = Blog post on =
470 [[Create a new blog post on>>xwiki:Blog.WebHome]]. You can have a look at the [[previous release blog posts>>xwiki:Blog.Releases]] for inspiration.
472 {{comment}}
473 In order to display the new blog post in the "Latest Blog Posts" sections of the homepage, you need to **refresh the document cache** that is currently used. To do that, [[edit the macro object's code>>]], look for the "cache" macro call and modify the "id" parameter's value (for instance from "latestBlogPostsCache3" to "latestBlogPostsCache4"). This will trigger a refresh on the homepage and the new blog post will be listed.
474 {{/comment}}
476 = Update =
478 is different from You can not simply edit the [[XWiki page>>]] and update the version value (or a special template page like it is done for en). Instead, you need to press the "pencil" icon next to the version value and be redirected to, the site that manages the data displayed by the infobox. There, you need to:
480 * Add a new version entry to the existing list ("+ ajouter une valeur" button at the end of the list)
481 * Enter the version number
482 * Press "+ ajouter un qualificatif"
483 * Type "date de publication" in the suggest box and select it.
484 * On the right, type the release date in the format "26 janvier 2021"
485 * Click on the control left to the version you have entered (the one with a small arrow pointing up) and select "Rang prefere". This will make it selected and displayed on the XWiki page.
486 * Press "publier" to publish you new version
487 * Click "modifier" for a version just before the one you have added that has the small arrow control pointing up.
488 * Click on the arrow control and select "Rang normal". This will make it deselected so that it is not displayed on the XWiki page.
489 * Check the [[XWiki page>>]] if the new version and date are properly displayed
491 = Update Wikimatrix =
493 This step must be performed only for the latest final releases (not bugfixes or RCs).
495 If it's the first time please register on and ask someone (Thomas for example) to get admin access to XWiki project for you.
497 Note: The only exception when a bugfix would be added here is when it would be done for the latest released final version (e.g. latest final is 10.2 and the bugfix is 10.2.1).
499 = Forum Announcement =
501 * Add a new post to the users forum on
502 * Example post:
503 ** Subject: {{code language="none"}}XWiki <version> released{{/code}}
504 ** Content:(((
505 {{code language="none"}}
506 The XWiki development team is proud to announce the availability of XWiki <version>.
507 <short summary>
509 You can download it here:
511 Make sure to review the release notes:
512<short version>
514 Thanks for your support
515 -The XWiki dev team
516 {{/code}}
517 )))
518 ** Category: {{code language="none"}}News & Events{{/code}}
519 ** Tags: {{code language="none"}}release{{/code}}
521 = Announce on Twitter =
523 To announce the new release on Twitter using [[`s account>>]]. Use the following type of text:
525 {{code language="bash"}}
526 [email protected]:~$ twidge update "#XWiki 8.4.1 has been #released! Check it out:"
527 {{/code}}
529 = Rebuild Debian Distribution =
531 The XWiki Debian distribution is automatically rebuilt every day using a crontab on
533 However, in order for the Debian distribution to be ready when we announce a new version, it's a good thing to force rebuild it.
535 This is achieved by logging on with the ##maven## user and trigger a rebuild of the Debian index.
537 {{warning}}
538 If the released version is starting a new LTS branch you will first need to update the script accordingly:
539 * update with the new LTS branch base version
540 * pull the new script version:
541 {{code language="sh"}}
542 cd xwiki-release-scripts && git pull && cd -
543 {{/code}}
544 {{/warning}}
546 Run the script.
548 {{code language="sh"}}
549 nohup /home/maven/ &
550 {{/code}}
552 This start the index update in the background, you can leave.
554 = Force Extensions Update =
556 In order to have up to date versions on you should trigger the {{velocity}}[[Batch importer scheduler>>]]{{/velocity}} (from the first node of the cluster).
558 = Update Docker =
560 {{info}}
561 This should be done only for final versions (i.e. includes bugfixes)
562 {{/info}}
564 See documentation in the [[Docker GitHub project's README>>]].
566 {{info}}
567 If you need help, ask Vincent :)
568 {{/info}}
570 {{info}}
571 Crash course on Docker:
573 Docker can create Images based on a Dockerfile (or a Compose file). Docker can also download Images from the DockerHub repository. Docker can create Containers from images. Docker also creates internal Volume unless you create mapped Volumes on your host computer so that you can navigate in them as local directories.
575 * {{code}}docker run{{/code}} creates a container locally based on an existing docker image.
576 * {{code}}docker ps{{/code}} lists the ids of running containers
577 * {{code}}docker ps -a{{/code}} lists the ids of all containers (running or not)
578 * {{code}}docker start <id>{{/code}} starts an existing container
579 * {{code}}docker stop <id>{{/code}} stop a running container
580 * {{code}}docker rm <id>{{/code}} removes an existing container
581 * {{code}}docker volume ls{{/code}} lists existing volumes
582 * {{code}}docker volume rm{{/code}} removes an existing volume
583 * {{code}}docker system prune{{/code}} removes unused data
584 * {{code}}docker network create{{/code}} creates a docker network so that several containers can see each other
585 * {{code}}docker network ls{{/code}} lists existing docker networks
586 * {{code}}docker network rm <id>{{/code}} removes an existing docker network
587 * {{code}}docker images{{/code}} lists all local images
588 * {{code}}docker rmi <id>{{/code}} removes an existing local image
589 {{/info}}

Get Connected