Skip to content

Commit

Permalink
Update documentation for 6.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@mbats
mbats committed Oct 19, 2015
1 parent a5aaebc commit 19f1fc2
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 93 deletions.
21 changes: 13 additions & 8 deletions documentation/developer-guide/build.textile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ We have a dedicated command for the product.

bq. You will retrieve product in: *packaging/org.obeonetwork.dsl.uml2.product/target/products/*

This command build:
This command builds:

!{{page.relativePath}}/images/UMLDesignerBuildProduct.png!

Expand Down Expand Up @@ -77,7 +77,7 @@ in org.obeonetwork.dsl.uml2.parent and add a `pom.xml` in your plugin with the f

h2. Continuous integration

Two continuous integration builds exist to build UML Designer. These builds run on "Travis-ci":https://travis-ci.org/.
One continuous integration builds exists to build UML Designer. This build runs on "Travis-ci":https://travis-ci.org/.

h3(#Build). UML-Designer build

Expand All @@ -88,20 +88,20 @@ This Travis "build": https://travis-ci.org/ObeoNetwork/UML-Designer/ is used to
* update the gh-pages (umldesigner.org web site),
* create the UML Designer update site and products.

This build deploys automatically the build artifacts on "S3":http://aws.amazon.com/fr/s3/ : "http://umldesigner.s3.amazonaws.com":http://umldesigner.s3.amazonaws.co
This build deploys automatically the build artifacts on "S3":http://aws.amazon.com/fr/s3/ : "http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com

The build is configured thanks to the "@.travis.yml@":https://github.com/ObeoNetwork/UML-Designer/blob/master/.travis.yml file.

Each time a commit is integrated on the github repository a nightly build is executed and the resulting update-site and products are deployed on s3:
http://s3.amazonaws.com/umldesigner/nightly/$BRANCH_NAME.
http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/$BRANCH_NAME.

The build deploys in S3 @umldesigner@ bucket:
The build deploys in S3 @obeo-umldesigner-nightly@ bucket:
* the @repository@ folder: the UML Designer nightly update site.
* the @org.obeonetwork.dsl.uml2.update-nightly.zip@ : a zip of the nightly update site.
* the @bundles@ folder: the nightly products.
* the @bundles@: the nightly products.
* the @umldesigner-xxx.tpd@: the target platform used to build the update site and products.

The deploy phase is active only for specific branches: "@master@":https://github.com/ObeoNetwork/UML-Designer/tree/master, "@5.0.x@":https://github.com/ObeoNetwork/UML-Designer/tree/5.0.x.
The deploy phase is active only for specific branches: "@master@":https://github.com/ObeoNetwork/UML-Designer/tree/master, "@5.0.x@":https://github.com/ObeoNetwork/UML-Designer/tree/5.0.x, "@5.0.x_juno3.8@":https://github.com/ObeoNetwork/UML-Designer/tree/5.0.x_juno3.8.

The "umldesigner.org":http://www.umldesigner.org web site is also updated and deployed thanks to this build. For more details about the web site have a look to the "documentation section":{{page.relativePath}}/developer-guide/documentation.html of the developer guide.

Expand All @@ -113,4 +113,9 @@ h3(#UI_Tests_build). UML-Designer-UI-Tests build

The Travis "UI tests build": https://travis-ci.org/ObeoNetwork/UML-Designer-UI-Tests is used to launch the UI tests.
This build deploys the tests results on S3:
http://s3.amazonaws.com/umldesigner/nightly/$BRANCH_NAME/test-results/$JOB_NUMBER.
http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/$BRANCH_NAME/test-results/$JOB_NUMBER.

h4. Make a release

When a new tag is pushed on the git repository a release is deployed on the S3 : http://obeo-umldesigner-releases.s3-website-eu-west-1.amazonaws.com/$TAG. The same tag must be added on the test project in order that the UI tests are relaunched and the results will be provided in:
http://obeo-umldesigner-releases.s3-website-eu-west-1.amazonaws.com/$TAG/test-results.
8 changes: 6 additions & 2 deletions documentation/developer-guide/contribute.textile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ Give us feedback by filling in our "survey":http://bit.ly/UMLDesignerSurvey!

h2. Get the developer environment

In UML Designer, we use target-platforms to define explicitly plugins and features available in the build context. We use it also to work on UML Designer in our Eclipse IDE.
An "Oomph":https://projects.eclipse.org/projects/tools.oomph setup is provided to ease the installation of the developer environment : "UMLDesigner.setup":https://github.com/ObeoNetwork/UML-Designer/blob/master/releng/org.obeonetwork.dsl.uml2.settings/UMLDesigner.setup

bq. To use it, you should import the releng/org.obeonetwork.dsl.uml2.target project in your own IDE and set the ".target" as target-platform.
1. Download "Oomph installer":https://wiki.eclipse.org/Eclipse_Oomph_Installer and launch it.
2. Launch Oomph installer and switched to the _Advanced mode_, Select an Eclipse platform and click on _Next_
3. Add the "UML Designer setup file":https://github.com/ObeoNetwork/UML-Designer/blob/master/releng/org.obeonetwork.dsl.uml2.settings/UMLDesigner.setup into _User_ folder. Select the UMLDesigner *AND* double-click on it to be sure that it is listed in the bottom projects listing. Then click _Next_. Then select where you want to install the UML Designer development environment.
4. When the installation is finished, you need to activate manually the target platform to use : releng/org.obeonetwork.dsl.uml2.target. We use target-platforms to define explicitly plugins and features available in the build context the same are used also to work on UML Designer in our Eclipse IDE.
5. Let's go contributing to UML Designer!
32 changes: 16 additions & 16 deletions documentation/developer-guide/release.textile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,31 @@ This table lists all the steps to follow to release a new UML Designer version.

h2. Prepare/validate nightly

|Action | v6.0.0|
|"Release 0":{{ page.relativePath }}/developer-guide/release.html#release0 | In progress|
|"Release 1":{{ page.relativePath }}/developer-guide/release.html#release1 | KO|
|"Release 2":{{ page.relativePath }}/developer-guide/release.html#release2 | KO|
|"Release 3":{{ page.relativePath }}/developer-guide/release.html#release3 | KO|
|"Release 4":{{ page.relativePath }}/developer-guide/release.html#release4 | KO|
|"Release 5":{{ page.relativePath }}/developer-guide/release.html#release5 | KO|
|"Release 6":{{ page.relativePath }}/developer-guide/release.html#release6 | KO|
|"Release 7":{{ page.relativePath }}/developer-guide/release.html#release7 | KO|
|"Release 8":{{ page.relativePath }}/developer-guide/release.html#release8 | KO|
|Action |v6.0.0|
|"Release 0":{{ page.relativePath }}/developer-guide/release.html#release0 | OK|
|"Release 1":{{ page.relativePath }}/developer-guide/release.html#release1 | OK|
|"Release 2":{{ page.relativePath }}/developer-guide/release.html#release2 | OK|
|"Release 3":{{ page.relativePath }}/developer-guide/release.html#release3 | OK|
|"Release 4":{{ page.relativePath }}/developer-guide/release.html#release4 | OK|
|"Release 5":{{ page.relativePath }}/developer-guide/release.html#release5 | OK|
|"Release 6":{{ page.relativePath }}/developer-guide/release.html#release6 | OK|
|"Release 7":{{ page.relativePath }}/developer-guide/release.html#release7 | OK|
|"Release 8":{{ page.relativePath }}/developer-guide/release.html#release8 | OK|

h1. Deploy on umldesigner.org

|Action |v6.0.0|
|"Release 9":{{ page.relativePath }}/developer-guide/release.html#release9 | KO|
|"Release 10":{{ page.relativePath }}/developer-guide/release.html#release10 | KO|
|"Release 9":{{ page.relativePath }}/developer-guide/release.html#release9 | OK|
|"Release 10":{{ page.relativePath }}/developer-guide/release.html#release10 | OK|
|"Release 11":{{ page.relativePath }}/developer-guide/release.html#release11 | KO|
|"Release 12":{{ page.relativePath }}/developer-guide/release.html#release12 | KO|
|"Release 13":{{ page.relativePath }}/developer-guide/release.html#release13 | KO|
|"Release 14":{{ page.relativePath }}/developer-guide/release.html#release14 | KO|
|"Release 12":{{ page.relativePath }}/developer-guide/release.html#release12 | OK|
|"Release 13":{{ page.relativePath }}/developer-guide/release.html#release13 | OK|
|"Release 14":{{ page.relativePath }}/developer-guide/release.html#release14 | OK|

h2. Deploy on Eclipse marketplace

|Action |v6.0.0|
|"Release 15":{{ page.relativePath }}/developer-guide/release.html#release15 | KO|
|"Release 15":{{ page.relativePath }}/developer-guide/release.html#release15 | OK|
|"Release 16":{{ page.relativePath }}/developer-guide/release.html#release16 | KO|

h2. Deploy on the obeonetwork
Expand Down
1 change: 1 addition & 0 deletions documentation/download/index.textile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ h2. Download & Install

|_. Version |_. Release notes |_. Bundles |_. Source code |_. Update site |
| _Nightly_|"_Sirius 3.0 / Mars_":https://github.com/ObeoNetwork/UML-Designer/milestones| "_Win32_":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/bundles/UMLDesigner-win32.win32.x86.zip, "_Win64_":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/bundles/UMLDesigner-win32.win32.x86_64.zip, "_Linux32_":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/bundles/UMLDesigner-linux.gtk.x86.zip, "_Linux64_":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/bundles/UMLDesigner-linux.gtk.x86_64.zip, "_MacOs64_":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/bundles/UMLDesigner-macosx.cocoa.x86_64.zip|"_master_":https://github.com/ObeoNetwork/UML-Designer/tree/master|"_http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/repository_":{{page.relativePath}}/download/index.html#Update_Sites, "_zip_":http://obeo-umldesigner-nightly.s3-website-eu-west-1.amazonaws.com/master/org.obeonetwork.dsl.uml2.update-nightly.zip |
| 6.0.0|"Sirius 3.0 / Mars.1":https://github.com/ObeoNetwork/UML-Designer/releases/tag/6.0.0| "Win32":http://releases.umldesigner.org/6.0.0/UMLDesigner-win32.win32.x86.zip, "Win64":http://releases.umldesigner.org/6.0.0/UMLDesigner-win32.win32.x86_64.zip, "Linux32":http://releases.umldesigner.org/6.0.0/UMLDesigner-linux.gtk.x86.zip, "Linux64":http://releases.umldesigner.org/6.0.0/UMLDesigner-linux.gtk.x86_64.zip, "MacOs64":http://releases.umldesigner.org/6.0.0/UMLDesigner-macosx.cocoa.x86_64.zip| "6.0.0 tag":https://github.com/ObeoNetwork/UML-Designer/tree/6.0.0|"http://releases.umldesigner.org/6.0.0/repository/":{{page.relativePath}}/download/index.html#Update_Sites, "zip":http://releases.umldesigner.org/6.0.0/org.obeonetwork.dsl.uml2.product-6.0.0-SNAPSHOT.zip|
| 5.0.0|"Sirius 2.0 / Luna":https://github.com/ObeoNetwork/UML-Designer/releases/tag/5.0.0| "Win32":http://releases.umldesigner.org/5.0.0/UMLDesigner-win32.win32.x86.zip, "Win64":http://releases.umldesigner.org/5.0.0/UMLDesigner-win32.win32.x86_64.zip, "Linux32":http://releases.umldesigner.org/5.0.0/UMLDesigner-linux.gtk.x86.zip, "Linux64":http://releases.umldesigner.org/5.0.0/UMLDesigner-linux.gtk.x86_64.zip, "MacOs64":http://releases.umldesigner.org/5.0.0/UMLDesigner-macosx.cocoa.x86_64.zip| "5.0.0 tag":https://github.com/ObeoNetwork/UML-Designer/tree/5.0.0|"http://releases.umldesigner.org/5.0.0/repository/":{{page.relativePath}}/download/index.html#Update_Sites, "zip":http://releases.umldesigner.org/5.0.0/org.obeonetwork.dsl.uml2.product-5.0.0-SNAPSHOT.zip|
| 4.0.1|"Sirius 1.0 / Luna":https://github.com/ObeoNetwork/UML-Designer/releases/tag/4.0.1| "Win32":http://releases.umldesigner.org/4.0.1/UMLDesigner-win32.win32.x86.zip, "Win64":http://releases.umldesigner.org/4.0.1/UMLDesigner-win32.win32.x86_64.zip, "Linux32":http://releases.umldesigner.org/4.0.1/UMLDesigner-linux.gtk.x86.zip, "Linux64":http://releases.umldesigner.org/4.0.1/UMLDesigner-linux.gtk.x86_64.zip, "MacOs64":http://releases.umldesigner.org/4.0.1/UMLDesigner-macosx.cocoa.x86_64.zip| "4.0.1 tag":https://github.com/ObeoNetwork/UML-Designer/tree/4.0.1|"http://releases.umldesigner.org/4.0.1/repository/":{{page.relativePath}}/download/index.html#Update_Sites, "zip":http://releases.umldesigner.org/4.0.1/org.obeonetwork.dsl.uml2.product-4.0.1-SNAPSHOT.zip|
| 3.0.0|"Obeo Designer 6.2 / Kepler":https://github.com/ObeoNetwork/UML-Designer/releases/tag/3.0.0| "Win32":http://releases.umldesigner.org/3.0.0/UMLDesigner-win32.win32.x86.zip, "Win64":http://releases.umldesigner.org/3.0.0/UMLDesigner-win32.win32.x86_64.zip, "Linux32":http://releases.umldesigner.org/3.0.0/UMLDesigner-linux.gtk.x86.zip, "Linux64":http://releases.umldesigner.org/3.0.0/UMLDesigner-linux.gtk.x86_64.zip, "MacOs64":http://releases.umldesigner.org/4.0.1/UMLDesigner-macosx.cocoa.x86_64.zip| "3.0.0 tag":https://github.com/ObeoNetwork/UML-Designer/tree/3.0.0|"http://releases.umldesigner.org/3.0.0/repository/":{{page.relativePath}}/download/index.html#Update_Sites|
Expand Down
67 changes: 0 additions & 67 deletions releng/org.obeonetwork.dsl.uml2.target/umldesigner-luna.target
View file

This file was deleted.

0 comments on commit 19f1fc2

Please sign in to comment.