Skip to content

Deploying

TCLethbridge edited this page Jan 8, 2021 · 6 revisions
Clone this wiki locally

Deploying

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

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, but deploying should be done regularly after prs are merged.

UmpleOnline

This process changed completely in fall 2020 when the master live UmpleOnline server was moved to be hosted by compute Canada. The following needs to be automated again, as it once was.

To deploy now, after a successful build in Travis and Appveyor of a merge to master.

  1. Verify that the server is not being very heavily used. It would be best to wait for a time when relatively fewer users are working live on the system.

  2. Log in to the server and go to directory ~/testumple/build and run bumple.

  3. After it completes, verify that the following is working: https://cruise.umple.org/test/umpleonline/ (also accessible as http://test.umple.org) and that https://try.umple.org is also still working correctly with the old version.

  4. Verify the test manual at http://testmanual.umple.org and also verify the test cruise directory and test umple home page

  5. go to the directory ~/umple/build and run bumple

  6. After it completes verify that https://try.umple.org is working

  7. Check various pages in https://manual.umple.org and https://cruise.umple.org

  8. Verify the docker image that was build at http://docker.umple.org

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 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