Commit 4f8cdfd3 authored by Benedikt Kleinmeier's avatar Benedikt Kleinmeier

Finalize 1-click-deployment in ".gitlab-ci.yml"

parent ca87e8e6
......@@ -4,7 +4,7 @@
# Windows).
#
# Procedure: Use GitLab job templates prefixed with a "." and use them in the
# actual job description with the "extend" keyword.
# actual job description with the "extends" keyword.
#
# ## Job Description Syntax
#
......@@ -77,7 +77,7 @@ stages:
script:
- mvn clean
- mvn -Dmaven.test.skip=true package
- python3 -m zipfile -c ${VADERE_PACKAGE_NAME_BRANCHES} VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
- python3 -m zipfile -c ${VADERE_PACKAGE_NAME_BRANCHES} README.md VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
- scp ${VADERE_PACKAGE_NAME_BRANCHES} di49mur@webdev-mwn.lrz.de:~/webserver/htdocs/builds/master/${VADERE_PACKAGE_NAME_BRANCHES}
only:
refs:
......@@ -89,11 +89,12 @@ stages:
script:
- mvn clean
- mvn -Dmaven.test.skip=true package
- python3 -m zipfile -c ${VADERE_PACKAGE_NAME_RELEASES} VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
- scp ${VADERE_PACKAGE_NAME_RELEASES} di49mur@webdev-mwn.lrz.de:~/webserver/htdocs/builds/master/${VADERE_PACKAGE_NAME_RELEASES}
- python3 -m zipfile -c ${VADERE_PACKAGE_NAME_RELEASES} README.md VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
- scp ${VADERE_PACKAGE_NAME_RELEASES} di49mur@webdev-mwn.lrz.de:~/webserver/htdocs/builds/stable/${VADERE_PACKAGE_NAME_RELEASES}
# Run job only for "tags" (usually on the "stable" branch). Watch out: Multiple "only" tags are ORed together.
# See: https://gitlab.com/gitlab-org/gitlab-ce/issues/27818
only:
refs:
- stable
- tags
when: on_success
.template_deploy_branch_manually:
......@@ -101,7 +102,7 @@ stages:
script:
- mvn clean
- mvn -Dmaven.test.skip=true package
- python3 -m zipfile -c ${VADERE_PACKAGE_NAME_BRANCHES} VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
- python3 -m zipfile -c ${VADERE_PACKAGE_NAME_BRANCHES} README.md VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
- scp ${VADERE_PACKAGE_NAME_BRANCHES} di49mur@webdev-mwn.lrz.de:~/webserver/htdocs/builds/branches/${VADERE_PACKAGE_NAME_BRANCHES}
when: manual
......@@ -119,7 +120,6 @@ stages:
expire_in: 1 week
when: on_success
# Job Definitions
## Jobs for GNU/Linux runner (which is labelled with tag "linux")
......@@ -145,7 +145,15 @@ deploy_master_on_linux:
environment:
name: master/linux
url: ${VADERE_DEPLOYMENT_BASE_URL}/master/vadere.${CI_COMMIT_REF_NAME}.${CI_RUNNER_TAGS}.zip
deploy_stable_on_linux:
extends: .template_deploy_stable_automatically
tags:
- linux
environment:
name: stable/linux
url: ${VADERE_DEPLOYMENT_BASE_URL}/stable/vadere.${CI_COMMIT_TAG}.${CI_RUNNER_TAGS}.zip
deploy_branch_on_linux:
extends: .template_deploy_branch_manually
tags:
......@@ -178,6 +186,14 @@ deploy_master_on_windows:
name: master/windows
url: ${VADERE_DEPLOYMENT_BASE_URL}/master/vadere.${CI_COMMIT_REF_NAME}.${CI_RUNNER_TAGS}.zip
deploy_stable_on_windows:
extends: .template_deploy_stable_automatically
tags:
- windows
environment:
name: stable/windows
url: ${VADERE_DEPLOYMENT_BASE_URL}/stable/vadere.${CI_COMMIT_TAG}.${CI_RUNNER_TAGS}.zip
deploy_branch_on_windows:
extends: .template_deploy_branch_manually
tags:
......
......@@ -7,17 +7,14 @@
### Added
- Configured 1-click-deployment in ".gitlab-ci.yml".
* The build pipeline consists of three stages: unit_test, integration_test and deploy.
* These stages run sequentially. The build pipeline is stopped if one stage fails.
* The jobs in "integration_test" and "deploy" are marked as "manual". I.e., these jobs
must be triggered via the play button in the GitLab web interface:
https://gitlab.lrz.de/vadere/vadere/pipelines
* The jobs in the "integration_test" stage run manual because of a bug in GitLab which
does not allow to run manual jobs (e.g., from deploy stage) when the pipeline fails.
In Vadere, this situation arises because of our seed test. Link to issue on GitLab website:
https://gitlab.com/gitlab-org/gitlab-ce/issues/51645
* The link to the deployed items can be found in the GitLab web interface:
https://gitlab.lrz.de/vadere/vadere/environments
* In short: Vadere is packaged as a single ZIP file containing following build artifacts: README.md VadereModelTests/ VadereGui/target/vadere.jar VadereSimulator/target/vadere-console.jar
* Vadere is packaged for GNU/Linux and Microsoft Windows.
* The ZIP file can be accessed on the website via: http://www.vadere.org/releases/
* The website's filesystem contains three subdirectories for releases:
- builds/master: For releases on "master" branch (automatically triggered when pushing to "master" branch).
- builds/stable: For Git tags on on any branch (automatically triggered when pushing tags).
- builds/branches: For releases of any other branch (manually triggered in web interface: https://gitlab.lrz.de/vadere/vadere/pipelines)
* The link to the deployed items can be also found in the GitLab web interface: https://gitlab.lrz.de/vadere/vadere/environments
- Create a Facade for the logging in vadere. This will remove 3rd party
dependencies in source most files. Only a small set of facade classes
will have the dependency.
......
......@@ -24,19 +24,20 @@ The Vadere framework includes a mesh generator for unstructured high-quality 2D
## Installation
### Download builds
### Download Releases
* Windows: [Latest build](http://www.vadere.org/builds/master/vadere.master.windows.zip)
* Linux: [Latest build](http://www.vadere.org/builds/master/vadere.master.linux.zip)
The zip-file contains:
The ZIP file contains:
* **README.md** - this README file.
* **vadere.jar** - provides Vadere with a GUI.
* **vadere_console.jar** - provides an command line API and therefore allows easy integration of Vadere into other applications.
* **vadere_console.jar** - provides the command line version of Vadere and allows easy integration into other applications.
* **VadereModelTests** - contains test scenarios for pedestrian locomotion models. Note: The tests are also useful for a "getting started" (see below "Run Built-In Examples" for details).
To execute the `.jar` files it is highly recommended to use Java 8.
### Build from source
### Build from Source
#### Dependencies
......@@ -75,12 +76,12 @@ With the following steps, you can run a simulation with one of the built-in exam
- start Vadere
- *Project* > *Open*
- choose `vadere.project` of one of the projects e.g. [TestOSM](VadereModelTests/TestOSM) and click *open*
- choose `vadere.project` of one of the projects e.g. [TestOSM](https://gitlab.lrz.de/vadere/vadere/tree/master/VadereModelTests/TestOSM) and click *open*
- select the scenario on the left and press *run selected scenario*
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
See [CHANGELOG.md](https://gitlab.lrz.de/vadere/vadere/blob/master/CHANGELOG.md) for a list of changes.
## JavaDoc
......@@ -88,10 +89,10 @@ See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
## Contribution
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to set up the development environment and the coding guidelines.
See [CONTRIBUTING.md](https://gitlab.lrz.de/vadere/vadere/blob/master/CONTRIBUTING.md) for how to set up the development environment and the coding guidelines.
## License
This software is licensed under the GNU Lesser General Public License ([LGPL](LICENSE)).
This software is licensed under the GNU Lesser General Public License ([LGPL](https://gitlab.lrz.de/vadere/vadere/blob/master/LICENSE)).
For more information: http://www.gnu.org/licenses/lgpl.html
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment