Update Help for release actions with new automated scripts authored by Thibaut ROMAIN's avatar Thibaut ROMAIN
...@@ -75,7 +75,7 @@ Make sure all the MR related to this release are attributed to the corresponding ...@@ -75,7 +75,7 @@ Make sure all the MR related to this release are attributed to the corresponding
Generate the release notes category by category, using the gitlab API and the `jq` command line program (json processing). For example, to fetch all %7.0.0 MR labeled ~feature: Generate the release notes category by category, using the gitlab API and the `jq` command line program (json processing). For example, to fetch all %7.0.0 MR labeled ~feature:
```bash ```bash
curl "https://gitlab.orfeo-toolbox.org/api/v4/projects/53/merge_requests?state=merged&milestone=7.0.0&per_page=100&labels=feature&page=1" | jq '.[] | "Merge Request !"+(.iid|tostring)+": " + .title+" by "+.author.name' curl "https://gitlab.orfeo-toolbox.org/api/v4/projects/53/merge_requests?state=merged&milestone=9.0.0&per_page=100&labels=feature&page=1" | jq '.[] | "Merge Request !"+(.iid|tostring)+": " + .title+" by "+.author.name'
``` ```
Some cleaning may be needed: Some cleaning may be needed:
...@@ -95,47 +95,6 @@ The tool (based on codespell) will identify potential spelling errors ...@@ -95,47 +95,6 @@ The tool (based on codespell) will identify potential spelling errors
and suggest a replacement. The user accepts or refuses those changes and suggest a replacement. The user accepts or refuses those changes
(Y/n). (Y/n).
## Translation for Monteverdi & Mapla
The translation is done using Qt tools. The strings to translate have a
special definition in the source code. Qt tools such as lupdate or
lrelease can parse and register them in a `.ts` file. This file is the
source file for translation, it contains original strings and their
translation. There is one `.ts` for each translation language.
Currently, OTB only has a french translation file : `i18n/fr_FR.ts`. To
parse again all the strings in source code and update the ts file, you
should :
- Go to a build directory of OTB with Monteverdi and Mapla enabled.
- Enable the option **OTB\_I18N\_MERGE\_TS** and build the target
`i18n`
<!-- end list -->
cmake -D OTB_I18N_MERGE_TS:BOOL=ON .
make i18n
It will update the ts file with the new strings detected. Take caution
because when OTB\_I18N\_MERGE\_TS is ON, the call to make clean will
remove the TS file.
- Disable OTB\_I18N\_MERGE\_TS for safety and faster build
<!-- end list -->
cmake -D OTB_I18N_MERGE_TS:BOOL=OFF .
- Go to the corresponding OTB source directory
- Add a translation for strings that don't have any, using a text
editor or linguist tool. Beware, the translation of the keymap is a
bit tricky (html formatted bloc).
<!-- end list -->
linguist i18n/fr_FR.ts
- Finally commit changes made to the TS file.
## OTB website ## OTB website
The resources for OTB website are placed in separate folders : The resources for OTB website are placed in separate folders :
...@@ -143,7 +102,7 @@ The resources for OTB website are placed in separate folders : ...@@ -143,7 +102,7 @@ The resources for OTB website are placed in separate folders :
- /var/www/doc : all resources for documentation - /var/www/doc : all resources for documentation
- /var/www/archives : storage for source code, binary packages, and - /var/www/archives : storage for source code, binary packages, and
other archives other archives
- /var/www/wordpress-4.0 : website architecture - /var/www/wordpress-4.4 : website architecture
A lot of resources are accessed with symlinks. The advised command to A lot of resources are accessed with symlinks. The advised command to
define a symlink is : define a symlink is :
...@@ -191,6 +150,14 @@ If this archive is for develop, use the naming conventions : ...@@ -191,6 +150,14 @@ If this archive is for develop, use the naming conventions :
### Promote staging packages ### Promote staging packages
Since version 9.0, there are scripts available to promote staging packages and the documentation.
`cd /var/www/archives/packages/deploy_scripts`
`sh deploy_packages_from_ci.sh`
Verify that the packages are well copied in the archives/OTB folder.
Alternatively, you can do it manually :
On OTB server, copy standalone packages from On OTB server, copy standalone packages from
`/var/www/archives/packages/ci/staging` to 2 locations : `/var/www/archives/packages/ci/staging` to 2 locations :
...@@ -199,10 +166,8 @@ On OTB server, copy standalone packages from ...@@ -199,10 +166,8 @@ On OTB server, copy standalone packages from
You shall copy the following binaries: You shall copy the following binaries:
- OTB Windows 32bit
- OTB Windows 64bit - OTB Windows 64bit
- OTB Linux 64bit - OTB Linux 64bit
- OTB MacOSX 64bit
Then, cleanup in the packages folder if relevant: Then, cleanup in the packages folder if relevant:
...@@ -212,9 +177,8 @@ Then, cleanup in the packages folder if relevant: ...@@ -212,9 +177,8 @@ Then, cleanup in the packages folder if relevant:
For final release, update the symlinks in `/var/www/archives/qgis` : For final release, update the symlinks in `/var/www/archives/qgis` :
- `OTB-Win64.zip -> /var/www/archives/packages/OTB-MAJOR.MINOR.PATCH-Win64.zip` - `OTB-VERSION-Win64.zip -> /var/www/archives/packages/OTB-MAJOR.MINOR.PATCH-Win64.zip`
- `OTB-Linux64.run -> /var/www/archives/packages/OTB-MAJOR.MINOR.PATCH-Linux64.run` - `OTB-VERSION-Linux.tar.gz -> /var/www/archives/packages/OTB-MAJOR.MINOR.PATCH-Linux.tar.gz`
- `OTB-Darwin64.run -> /var/www/archives/packages/OTB-MAJOR.MINOR.PATCH-Darwin64.run`
### Update documentation ### Update documentation
...@@ -223,6 +187,12 @@ Updating documentation contains multiple steps: ...@@ -223,6 +187,12 @@ Updating documentation contains multiple steps:
- Cookbook - Cookbook
- Doxygen - Doxygen
For an automatic deployment :
`cd /var/www/archives/packages/deploy_scripts`
`sh deploy_documentation.sh`
For a manual deployment :
#### CookBook #### CookBook
The CookBook is generated for the latest commit on release branch. The tar.gz archive should be The CookBook is generated for the latest commit on release branch. The tar.gz archive should be
... ...
......