Changes
Page history
Update Help for release actions
authored
Jul 11, 2019
by
Guillaume Pasero
Show whitespace changes
Inline
Side-by-side
Help-for-release-actions.md
View page @
07e73fc6
...
@@ -20,19 +20,19 @@ Each number shall be replaced by the current release number.
...
@@ -20,19 +20,19 @@ Each number shall be replaced by the current release number.
Send the command to get a RC checkout in the announcement email, so that
Send the command to get a RC checkout in the announcement email, so that
more users try it.
more users try it.
git clone http://git
@git
.orfeo-toolbox.org/
git
/otb.git OTB
git clone http
s
://git
lab
.orfeo-toolbox.org/
orfeotoolbox
/otb.git OTB
cd OTB
cd OTB
git checkout -q --detach MAJOR.MINOR.PATCH-rc1
git checkout -q --detach MAJOR.MINOR.PATCH-rc1
### Release tag
### Release tag
For
sources with 'otb' workflow (OTB, OTB-Data)
, tag the release branch:
For
OTB repository
, tag the release branch:
git checkout release-X.Y
git checkout release-X.Y
git tag -a MAJOR.MINOR.PATCH -m "Release tag MAJOR.MINOR.PATCH"
git tag -a MAJOR.MINOR.PATCH -m "Release tag MAJOR.MINOR.PATCH"
git push --tags
git push --tags
For
sources without workflow
(OTB-Documents, OTB-DevUtils), tag master:
For
other repositories
(OTB-Documents, OTB-DevUtils
, otb-build-env
), tag master:
git checkout master
git checkout master
git tag -a MAJOR.MINOR.PATCH -m "Release tag MAJOR.MINOR.PATCH"
git tag -a MAJOR.MINOR.PATCH -m "Release tag MAJOR.MINOR.PATCH"
...
@@ -40,7 +40,7 @@ For sources without workflow (OTB-Documents, OTB-DevUtils), tag master:
...
@@ -40,7 +40,7 @@ For sources without workflow (OTB-Documents, OTB-DevUtils), tag master:
### Merge latest release into master
### Merge latest release into master
For both OTB and OTB-Data
:
On OTB repository
:
git checkout master
git checkout master
git merge release-X.Y
git merge release-X.Y
...
@@ -49,9 +49,9 @@ For both OTB and OTB-Data:
...
@@ -49,9 +49,9 @@ For both OTB and OTB-Data:
### Prepare and upload source packages
### Prepare and upload source packages
For convenience, nightly generated source packages should be available
For convenience, nightly generated source packages should be available
[
here
](
https://www.orfeo-toolbox.org/packages/
nightly/latest
/
)
.
[
here
](
https://www.orfeo-toolbox.org/packages/
ci/staging
/
)
.
For more information, check the script
`OTB
-DevUtils/Scripts/prepareSourcePackagesNightl
y.sh`
, and the command
`git archive`
.
For more information, check the script
`OTB
/CI/deplo
y.sh`
, and the command
`git archive`
.
You will have to copy and rename the release archives into 2 locations:
You will have to copy and rename the release archives into 2 locations:
...
@@ -69,18 +69,6 @@ packages directory. Older versions remain archived in:
...
@@ -69,18 +69,6 @@ packages directory. Older versions remain archived in:
/var/www/archives/packages/archives
/var/www/archives/packages/archives
## Dashboard
A few files need to be updated to make sure the dashboard will be
testing the new release branch:
-
[
OTB-DevUtils/Config/config\_stable.cmake
](
https://git.orfeo-toolbox.org/otb-devutils.git/blob/HEAD:/Config/config_stable.cmake
)
: update the
`OTB_STABLE_VERSION`
to new release number
X.Y
-
[
OTB-DevUtils/Config/windows/nightly.cmake
](
https://git.orfeo-toolbox.org/otb-devutils.git/blob/HEAD:/Config/windows/nightly.cmake
)
: make sure the option
`RELEASE_PREPARATION`
is ON (windows
platforms will use the release branch to produce packages).
## Spelling check
## Spelling check
This is a simple script to run, but it should be run from its directory.
This is a simple script to run, but it should be run from its directory.
...
@@ -189,7 +177,7 @@ If this archive is for develop, use the naming conventions :
...
@@ -189,7 +177,7 @@ If this archive is for develop, use the naming conventions :
### Promote nightly packages
### Promote nightly packages
On OTB server, copy standalone packages from
On OTB server, copy standalone packages from
`/var/www/archives/packages/
nightly/latest
`
to 2 locations :
`/var/www/archives/packages/
ci/staging
`
to 2 locations :
-
`/var/www/archives/packages`
-
`/var/www/archives/packages`
-
`/var/www/archives/packages/archives/OTB`
-
`/var/www/archives/packages/archives/OTB`
...
@@ -211,29 +199,8 @@ Then, cleanup in the packages folder if relevant:
...
@@ -211,29 +199,8 @@ Then, cleanup in the packages folder if relevant:
Updating documentation contains multiple steps:
Updating documentation contains multiple steps:
-
Software Guide
-
Cookbook
-
Cookbook
-
Doxygen
-
Doxygen
-
Application online documentation
#### SoftwareGuide
The SoftwareGuide is generated nightly. The PDF and tar.gz archive
should be copied in /var/www/archives/packages. The online html version
shall be deployed in /var/www/doc/SoftwareGuide-MAJOR.MINOR. In this
folder, you have to replace the files index.hml by
symlinks:
cp -R /var/www/archives/packages/nightly/latest/SoftwareGuide-MAJOR.MINOR /var/www/doc
cd /var/www/doc/SoftwareGuide-MAJOR.MINOR
rm index.html
ln -nsf SoftwareGuide.html index.html
The symlinks in /var/www/wordpress-4.0 have to be updated :
cd /var/www/wordref-4.0
ln -nsf ../doc/SoftwareGuide-MAJOR.MINOR SoftwareGuide-MAJOR.MINOR
ln -nsf SoftwareGuide-MAJOR.MINOR SoftwareGuide
#### CookBook
#### CookBook
...
...
...
...