Skip to content

Commit

Permalink
[docs] Add phase about release candidate version.
Browse files Browse the repository at this point in the history
Signed-off-by: Stéphane Galland <galland@arakhne.org>
  • Loading branch information
gallandarakhneorg committed Apr 8, 2015
1 parent 6a18438 commit 23e4122
Showing 1 changed file with 49 additions and 26 deletions.
75 changes: 49 additions & 26 deletions RELEASE_README.md
Expand Up @@ -4,19 +4,41 @@ RELEASE SARL

The steps for releasing SARL are:

A) PHASE 1: RELEASE VERSION
A) PHASE 1: RELEASE CANDIDATE VERSION

A.1) Remove "-SNAPSHOT" in all the poms.
A.1) Upgrade all the versions in the pom files and the Eclipse platform.

A.2) Update the versions in the Eclipse configurations:
A.2) Compiling locally without error.

$> rm -rf $HOME/.m2/repository
$> mvn clean install

You may compile the documentation is a different process if Maven complains to be out of memory.

$> cd docs/io.sarl.docs.suite
$> mvn clean install

A.3) Commit all the changes.

A.4) Tag the version with "vX.Y.Z-RCn" (where "n" is the release candidate number). And push the tag on Github.

A.3) Do manual tests.

A.5) If a manual test is failing: fix the problem, and go to step A.2.

B) PHASE 2: RELEASE VERSION

B.1) Remove "-SNAPSHOT" in all the poms.

B.2) Update the versions in the Eclipse configurations:
a) Remove ".qualifier" in the MANIFEST.MF files (in Bundle-Version).
b) Remove ".qualifier" in the feature.xml files (in root tag).
c) Remove ".qualifier" in the *.product files (in root tag and feature tag).
d) Remove ".qualifier" in the category.xml files (in feature tags, url and version).

A.3) Update the graphical resources (splash screen, icons...)
B.3) Update the graphical resources (splash screen, icons...)

A.4) Compiling locally without error.
B.4) Compiling locally without error.

$> rm -rf $HOME/.m2/repository
$> mvn clean install
Expand All @@ -26,50 +48,54 @@ A.4) Compiling locally without error.
$> cd docs/io.sarl.docs.suite
$> mvn clean install

A.5) Prepare the bundles for Maven Central:
B.5) Prepare the bundles for Maven Central:

$> ./scripts/prepare-bundles-for-central

A.6) Tag the Git with the version number.
B.6) Tag the Git with the version number.

$> git tag "vX.Y.Z"

A.7) Commit and push to Github:
B.7) Commit and push to Github:

$> git commit
$> git push --all

A.8) On Hudson, launch a build for updating the maven repositories and the Eclipse update sites.
If failing, revert 6, fix the problem, and go back to 4.
B.8) On Hudson, launch a build for updating the maven repositories and the Eclipse update sites.
If failing, revert B.6, fix the problem, and go back to B.4.

C) PHASE 3: DISSEMINATION OF THE RELEASE VERSION

A.9) Updload the Maven Bundle on Maven Central with [http://oss.sonatype.org](http://oss.sonatype.org)
C.1) Updload the Maven Bundle on Maven Central with [http://oss.sonatype.org](http://oss.sonatype.org)

A.10) Create the "Changes" page for the website, and add a link to the "Changes" page of the previous website inside.
C.2) Create the "Changes" page for the website, and add a link to the "Changes" page of the previous website inside.
In this way, it will be possible to following the change history from the ealier to older changes.

A.11) Synchronize the [Awesome SARL project](https://github.com/sarl/awesome-sarl) with the "Community" page of the website.
C.3) Synchronize the [Awesome SARL project](https://github.com/sarl/awesome-sarl) with the "Community" page of the website.

A.12) Update the SARL website:
C.4) Update the SARL website:

$> cd path/to/sarl-site
$> rake build_full
$> rake transfer

A.13) Commit and push the website Gits.
C.5) Commit and push the website Gits.

A.14) Move all the remaining issues on Github to the following version.
C.6) Move all the remaining issues on Github to the following version.

A.15) Close the released milestone on Github.
C.7) Close the released milestone on Github.

A.16) Add release notes on Github (from the Changes page on the website), attached to the release tag.
C.8) Add release notes on Github (from the Changes page on the website), attached to the release tag.

B) PHASE 2: NEW SNAPSHOT VERSION
C.9) Announce the new version of SARL on the mailing lists.

B.1) Revert steps 1 to 3; and change the following:
D) PHASE 4: DEVELOPMENT VERSION

D.1) Revert steps B.1 to B.3; and change the following:
* Version ranges in the Required-Bundles of MANIFEST.MF.
* Versions in the requirements of feature.xml.

B.2) Compiling locally without error.
D.2) Compiling locally without error.

$> rm -rf $HOME/.m2/repository
$> mvn clean install
Expand All @@ -79,14 +105,11 @@ B.2) Compiling locally without error.
$> cd docs/io.sarl.docs.suite
$> mvn clean install

B.3) Commit and push to Github:
D.3) Commit and push to Github:

$> git commit
$> git push --all

B.4) On Hudson, launch a build for updating the maven repositories and the Eclipse update sites.

C) PHASE 3: DISSEMINATION
D.4) On Hudson, launch a build for updating the maven repositories and the Eclipse update sites.

C.1) Announce the new version of SARL on the mailing lists.

0 comments on commit 23e4122

Please sign in to comment.