Deploying

TCLethbridge edited this page Jan 23, 2018 · 4 revisions

Deploying

Deploying simply means ensuring that changes that have been committed and built are available for use.

Deploying is not the same as releasing. Releasing is means creating a checkpoint version of Umple and increasing the version number. Details on releasing are documented separately. Deploying is one of the steps of releasing.

UmpleOnline

The only thing that needs to be manually deployed are files in the main live version of UmpleOnline at try.umple.org. This is to protect against accidentally taking down or making sudden changes to UmpleOnline at times when hundreds of people may be using it. We call deploying script and example changes on live umpleonline 'promoting'. The test version of Umpleonline at try.umple.org/test is automatically deployed, as are Docker versions for every branch push and PR (see http://docker.umple.org).

You first commit and do a PR for the changed files after testing on your own local UmpleOnline. Alternatively you can push to a non-master branch and then test by examining the Docker image that is built by Travis. If all is OK, the PR can be merged. After about 10 minutes, you should see the changes on try.umple.org/test

If alli s OK, on the server you run the script below. If you don't have access, ask the project leader to do this.

  promoteuol real

This tells you the files that need to be deployed to the test Umpleonline at http://cruise.eecs.uottawa.ca/umpleonline

If correct then you run

  promoteuol real go

Note: The above won't add new directories, If the commit adds new directories you need to add them manually first, and also add them to the promoteuol script which is in the bin directory on the cruise server.

Deploying the User Manual

The user manual is generated based on a set of simple text documents that allow you to provide a description of the language component, the basic syntax of the feature, and example umple code. This is then passed through a generator (umpledocs.jar) to create our HTML user manual. The 'mumple' script in dev-tools will do this for you.

Editing the User Manual

The user manual is located within trunk/build/reference

Organize the left hand table of content by editing the order.group file

And edit the individual pages by editing the .txt files

Here is an example user manual page

isA
Classes

@@description
Used to denote an inheritance relationship between two classes

@@syntax
isA [extendsName] ;

@@example

class Person
{
  name;
}

class Student
{
  isA Person;
  Integer number;
}
@@endexample

A page comprises the following

  • A title (in the example above, the title is isA
  • A group (e.g. Classes)
  • A brief description of the page (defined after @@description and takes any arbitrary HTML)
  • The language syntax (defined after @@syntax)
  • An Umple example (fined within @@example and @@endexample)

Only the title and group are mandatory, but you should also at least include a brief description.

Compiling Locally to HTML

To view the output, you will need to run umpledocs.jar against the directory. This has been wrapped within a ant task found within trunk/build.

Here is how to package the umple docs locally.

cd trunk/build
ant -Dmyenv=local -f build.umple.xml packageDocs

Deploy to Server

When you are satisfied with the look, commit your code and make a pull request. The server now deploys the user manual automatically when any PR is merged.

The manual is found at http://manual.umple.org

At the bottom left of each page is a link to the relevant source page in Github

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.