Merge branch 'master' into 5.0-alpha

.github/issue_template.md

@@ -0,0 +1,10 @@
+### Expected behavior
+
+### Actual behavior
+
+### Steps to reproduce
+
+### System information
+* software version (git revision) of phoenicis and scripts repositories
+* used operating system
+* used Java version

.travis.yml

@@ -1,50 +1,106 @@
 language: java
-sudo: false
+sudo: true # must have same "sudo" state in stages for caching
 
 # avoid double builds on pull requests
 branches:
   only:
     - master
     - 5.0-alpha
 
-addons:
-  apt:
-    packages:
-      - oracle-java8-installer
-      - oracle-java9-installer
+# caches for build artifacts
+cache:
+  directories:
+    - $HOME/travis_cache
 
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
-
-matrix:
+jobs:
   include:
-    # The normal tests
-    - jdk: oraclejdk8
+    # build cache
+    - stage: Build cache
       os: linux
       dist: trusty
-    - jdk: oraclejdk9
+      jdk: openjdk8
+      sudo: required
+      install: true
+      script:
+        - mv $HOME/travis_cache $HOME/travis_cache_old
+        - mkdir $HOME/travis_cache
+        - echo "$TRAVIS_BUILD_ID" > $HOME/travis_cache/travis_build_id
+
+    # Check format
+    - stage: Check format
+      # do not use default install (runs formatter)
+      install: true
+      script: mvn -Pcheck-formatted validate formatter:validate
+
+    # build + test
+    - stage: Build + test
+      os: linux
+      dist: trusty
+      jdk: openjdk8
+      sudo: required
+      services:
+        - docker
+      before_install:
+        - docker run -d --name ubuntu-16-04 -v $HOME:/travis openjdk:8 tail -f /dev/null
+      install:
+        - docker exec -t ubuntu-16-04 bash -c "apt -qq update;
+                                               apt install -y git;
+                                               apt install -y maven;
+                                               apt install -y openjfx;
+                                               apt install -y gettext"
+      script:
+        - docker exec -t ubuntu-16-04 bash -c "cd /travis;
+                                               git clone https://github.com/PhoenicisOrg/phoenicis.git;
+                                               cd phoenicis;
+                                               mvn -B clean package"
+      before_cache:
+        - docker exec -t ubuntu-16-04 bash -c "cp /travis/phoenicis/phoenicis-dist/target/*.deb /travis/travis_cache/"
+    # build + test
+    - stage: Build + test
       os: linux
       dist: trusty
-    - os: osx
-      osx_image: xcode9.2
-
-    # Check the format
-    - stage: Check format
       jdk: oraclejdk8
+      addons:
+        apt:
+          packages: oracle-java8-installer
+    - stage: Build + test
       os: linux
       dist: trusty
-      # do not use default install (runs formatter)
-      install: true
+      jdk: oraclejdk9
+      addons:
+        apt:
+          packages: oracle-java9-installer
+    - stage: Build + test
+      os: osx
+      osx_image: xcode9.2
+
+    # Install packages
+    # .deb
+    - stage: Install packages
+      os: linux
+      dist: trusty
+      jdk: openjdk8
+      sudo: required
+      services:
+        - docker
+      before_install:
+        - docker run -d --name ubuntu-16-04 -v $HOME:/travis ubuntu:16.04 tail -f /dev/null
+      install:
+        - docker exec -t ubuntu-16-04 bash -c "dpkg --add-architecture i386 && apt -qq update"
       script:
-        - mvn -Pcheck-formatted validate formatter:validate
+        # check that cache has been filled in current build
+        - if test "$TRAVIS_BUILD_ID" != `cat $HOME/travis_cache/travis_build_id`; then travis_terminate 1; fi
+        - rm -f $HOME/travis_cache/travis_build_id
+        - docker exec -t ubuntu-16-04 bash -c "apt install -y /travis/travis_cache/*.deb"
+        - mv $HOME/travis_cache $HOME/travis_cache_old
+        - mkdir $HOME/travis_cache # clear the cache
 
     # Check GitHub Pages
     - stage: Check GitHub Pages
-      os: linux
+      env: NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
       language: ruby
       rvm:
-        - 2.1
+        - 2.5
       before_install: cd docs
       script:
         - bundle exec jekyll build

README.md

@@ -1,5 +1,5 @@
 # Phoenicis PlayOnLinux and PlayOnMac 5
-[![Build Status](https://travis-ci.org/PhoenicisOrg/phoenicis.svg?branch=master)](https://travis-ci.org/PhoenicisOrg/phoenicis)
+[![Build Status](https://travis-ci.com/PhoenicisOrg/phoenicis.svg?branch=master)](https://travis-ci.com/PhoenicisOrg/phoenicis)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b667020df53c4b80a22d7e5a73f2b1b3)](https://www.codacy.com/app/PhoenicisOrg/phoenicis?utm_source=github.com&utm_medium=referral&utm_content=PhoenicisOrg/phoenicis&utm_campaign=Badge_Grade)
 [![Crowdin Badge](https://d322cqt584bo4o.cloudfront.net/phoenicis/localized.svg)](https://crowdin.com/project/phoenicis)
 

docs/.gitignore

@@ -0,0 +1,2 @@
+/_site/
+/Gemfile.lock

docs/404.md

@@ -0,0 +1,7 @@
+---
+title: Not Found
+permalink: /404.html
+sitemap: false
+---
+
+This page doesn't exist!

docs/Gemfile

@@ -1,11 +1,11 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "jekyll"
-gem "jekyll-remote-theme"
+gem 'jekyll', '3.7.2'
 
-gem "github-pages", group: :jekyll_plugins
+group :jekyll_plugins do
+  gem 'jekyll-feed', '0.9.3'
+  gem 'jekyll-seo-tag', '2.4.0'
+  gem 'jekyll-sitemap', '1.2.0'
+end
 
-# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-
-gem "html-proofer"
+gem "html-proofer"

docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 CloudCannon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/_config.yml

@@ -1,51 +1,71 @@
-title                    : Phoenicis Documentation
-name                     : phoenicis.org
-description              : The documentation for Phoenicis.
-repository               : PhoenicisOrg/phoenicis
+title: Phoenicis Documentation
+baseurl:
+google_analytics_key:
+show_full_navigation: true
 
-remote_theme             : mmistakes/minimal-mistakes
-minimal_mistakes_skin    : air
+# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
+logo: /siteicon.png
+description: The documentation for Phoenicis.
+author:
+  name:
+  email:
+  twitter: # twitter username without the @ symbol
+social:
+  name: Phoenicis Documentation
+  links:
+    - https://github.com/PhoenicisOrg/phoenicis
+
+# -----
+# Build
+
+timezone: Etc/UTC
 
-markdown                 : kramdown
-permalink                : /:categories/:title/
+permalink: pretty
 
 plugins:
-  - jekyll-paginate
   - jekyll-sitemap
-  - jekyll-gist
+  - jekyll-seo-tag
   - jekyll-feed
-  - jemoji
-  - jekyll-remote-theme
 
-# mimic GitHub Pages with --safe
-whitelist:
-  - jekyll-paginate
-  - jekyll-sitemap
-  - jekyll-gist
-  - jekyll-feed
-  - jemoji
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - LICENCE
 
-include:
-  - _pages
+collections:
+  docs:
+    title: Documentation
+    permalink: /:path/
+    output: true
 
-encoding: "utf-8"
-markdown_ext: "markdown,mkdown,mkdn,mkd,md"
-
 defaults:
-  # _pages
-  - scope:
-      path: "_pages"
-      type: pages
+  -
+    scope:
+      path: ""
     values:
-      layout: single
-      author_profile: false
-      sidebar:
-        nav: "docs"
-
-author:
-  name:   Phoenicis
-  github: PhoenicisOrg
+      layout: default
+  -
+    scope:
+      path: ""
+      type: "docs"
+    values:
+      seo:
+        type: Article
+      _comments:
+        category: Group navigation links with this field
+        order: Used to sort links in the navigation
+      _options:
+        content:
+          width: 800
+          height: 2000
+  -
+    scope:
+      path: ""
+      type: "posts"
+    values:
+      _comments:
+        type: Marks the impact of this release
 
-# HTML Compression
-compress_html:
-  clippings: all
+types:
+  - minor
+  - major

docs/_pages/intellij-idea.md → docs/_docs/Developers/intellij-idea.md

@@ -1,6 +1,7 @@
 ---
 title: "IntelliJ IDEA"
-permalink: /intellij-idea/
+category: Developers
+order: 1
 toc: true
 ---
 
@@ -14,6 +15,7 @@ Build phoenicis (root) → Lifecycle → package
 ### Run
 Run → Edit Configurations
 add: JavaFXApplication with main class org.phoenicis.javafx.JavaFXApplication
+![IntelliJ IDEA configuration](/images/intellij-idea-run.png)
 
 ### Code Style
 File → Settings → Editor → Code Style → Scheme: Manage... → Import → Eclipse XML Profile: select [settings/POL_Formatter_Settings.xml](https://github.com/PhoenicisOrg/phoenicis/blob/master/settings/POL_Formatter_Settings.xml)

docs/_pages/maven-modules.md → docs/_docs/Developers/maven-modules.md

@@ -1,6 +1,7 @@
 ---
 title: "Maven Modules"
-permalink: /maven-modules/
+category: Developers
+order: 2
 toc: true
 ---
 

docs/_docs/Developers/release-process.md

@@ -0,0 +1,22 @@
+---
+title: "Release process"
+category: Developers
+order: 5
+toc: false
+---
+
+The following steps must be executed to release a new version of Phoenicis:
+* Create release branches (e.g. "5.0-alpha") for phoenicis and scripts
+* Protect release branch
+    * Require pull request reviews before merging
+    * Require status checks to pass before merging (Travis CI and Codacy)
+* on the release branch:
+    * Add release branch to `branches` section of `.travis.yml` such that Travis CI executes checks for the branch
+    * Specify scripts release branch in configuration (`application.repository.default.git.url`)
+    * Set release version for Maven in `pom.xml` files
+    * Set release version in .deb control files
+* [Test]({{ site.baseurl }}{% link _docs/Developers/test-plan.md %})
+* Create GitHub release from the release branches for phoenicis and scripts
+* Announce release on phoenicis.org
+    * Showcase new features
+    * List major changes/fixed bugs