Merge pull request #31 from Staffbase/github-actions

Added Github workflow

Author: Ninerian

.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-20.04
+    name: Java ${{ matrix.java }} Test
+    strategy:
+      matrix:
+        # test against latest update of each major Java version, as well as specific updates of LTS versions:
+        java: [ 8, 10, 11, 12, 13, 14]
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up JDK ${{ matrix.java }}
+      uses: actions/setup-java@v1
+      with:
+        java-version: ${{ matrix.java }}
+
+    - name: Build with Maven
+      run: mvn -B package --file pom.xml
+
+    - name: Run UI tests
+      run: make test
+
+  continuous-delivery:
+    if: github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
+    needs: build-test
+    runs-on: ubuntu-20.04
+
+    steps:
+    - name: Check out Git repository
+      uses: actions/checkout@v2
+
+    - name: Install Java and Maven
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+
+    - name: Release Maven package
+      uses: samuelmeuli/action-maven-publish@v1
+      with:
+        gpg_private_key: ${{ secrets.gpg_private_key }}
+        gpg_passphrase: ${{ secrets.gpg_passphrase }}
+        nexus_username: ${{ secrets.nexus_username }}
+        nexus_password: ${{ secrets.nexus_password }}

.travis.yml

@@ -1,3 +1,5 @@
+[![Build Status](https://github.com/Staffbase/plugins-sdk-java/workflows/Continuous%20Integration/badge.svg)](https://github.com/Staffbase/plugins-sdk-java/actions)
+
 # Plugin SDK for Java
 
 If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/guide/customplugin-overview/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Java.

README.md

@@ -158,6 +158,9 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <version>3.2.0</version>
+                <configuration>
+                    <source>8</source>
+                </configuration>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -193,6 +196,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
                 <configuration>
                     <source>8</source>
                     <target>8</target>

pom.xml

@@ -304,10 +304,22 @@ public SSOData(final JwtClaims jwtClaims) throws MalformedClaimException {
    * Getters
    **********************************************/
 
+  /**
+   * Get the branch identifier of the installation
+   *
+   * @see #branchID
+   * @return the id to know which branch an installation belongs to
+   */
   public String getBranchID() {
       return this.branchID;
   }
 
+  /**
+   * Get the name of the branch an installation belongs to
+   *
+   * @see #branchSlug
+   * @return the name of the branch an installation belongs to
+   */
   public String getBranchSlug() {
       return this.branchSlug;
   }