Merge pull request #182 from doubleSlashde/develop

develop->master v2.0.x

Author: Death111

.github/workflows/mavenCi.yml

@@ -15,32 +15,31 @@ on:
 jobs:
 
   build-analyze:
-
     runs-on: ubuntu-latest
 
     env:
-      version: 1.3.${{ github.run_number }}
+      version: 2.0.${{ github.run_number }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set up JDK 11
-        uses: actions/setup-java@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
         with:
-          java-version: '11'
+          java-version: '17'
           distribution: 'corretto'
           cache: maven
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: 'java'
 
       - name: Build
         run:  mvn -V -B clean package org.jacoco:jacoco-maven-plugin:0.8.7:prepare-agent org.jacoco:jacoco-maven-plugin:0.8.7:report -Pcoverage -Dproject.version=${{ env.version }}-SNAPSHOT
 
       - name: Upload Build Artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: KeepTime-${{ env.version }}
           path: /home/runner/work/KeepTime/KeepTime/target/*-bin.zip
@@ -49,29 +48,41 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: mvn -V -B sonar:sonar
-          -Dsonar.host.url=${{ secrets.HOST_URL }}
-          -Dsonar.organization=${{ secrets.ORGANIZATION_NAME }}
-          -Dsonar.projectKey=${{ secrets.PROJECT_KEY }}
-          -Dsonar.java.binaries=.
-          -Dsonar.qualitygate.wait=false
+        run: mvn -V -B sonar:sonar -Dsonar.host.url=${{ secrets.HOST_URL }} -Dsonar.organization=${{ secrets.ORGANIZATION_NAME }} -Dsonar.projectKey=${{ secrets.PROJECT_KEY }} -Dsonar.java.binaries=. -Dsonar.qualitygate.wait=false
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
 
   dependency-check:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up JDK 11
-        uses: actions/setup-java@v3
-        with:
-          java-version: '11'
-          distribution: 'corretto'
-          cache: maven
-
-      - name: dependencyCheck
-        run:  mvn dependency-check:check
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout
+          uses: actions/checkout@v4
+        - name: Set up JDK 17
+          uses: actions/setup-java@v4
+          with:
+            java-version: '17'
+            distribution: 'corretto'
+            cache: maven
+        - name: Build
+          run: mvn -V -B clean package
+        - name: Depcheck
+          uses: dependency-check/Dependency-Check_Action@main
+          id: Depcheck
+          env:
+            # actions/setup-java@v1 changes JAVA_HOME so it needs to be reset to match the depcheck image
+            JAVA_HOME: /opt/jdk
+          with:
+            project: 'KeepTime'
+            path: '.'
+            format: 'HTML'
+            out: 'reports' # this is the default, no need to specify unless you wish to override it
+            args: >
+              --failOnCVSS 8.9
+              --enableRetired
+        - name: Upload Test results
+          if: always()
+          uses: actions/upload-artifact@v4
+          with:
+            name: Depcheck report
+            path: ${{github.workspace}}/reports

.gitignore

@@ -30,3 +30,4 @@ logs/
 
 config.xml
 /db/
+application.properties

README.md

@@ -35,7 +35,7 @@ Create projects and choose if they are counted as 'work time'. Select the projec
 
 ## Install
 
-* Download keeptime.bat and keeptime-<version>-bin.zip (see [releases](https://github.com/doubleSlashde/KeepTime/releases))
+* Download keeptime-\<version\>.zip (see [releases](https://github.com/doubleSlashde/KeepTime/releases))
 * Extract the downloaded .zip
 * Try starting the application by executing the *keeptime.bat* file. The start may take up to one minute.
 
@@ -45,26 +45,34 @@ It is recommended to run the application at computer start, so you do not forget
 
 You should put the .jar in an extra folder as a *logs* and a *db* folder will be created next to it.\
 
-### Migrate from older version than v1.2.0
+## Update KeepTime
+1. Start your current version of KeepTime
+1. Open `Settings` -> `Import/Export` -> `Export` to export your data to an .sql file (Backup data)
+1. Stop KeepTime
+1. Download new version of KeepTime and extract it
+1. Start new version of KeepTime
+1. If your projects are available you are already done. But most likely your projects are missing. In this case follow the [Migrate](#Migrate) chapter
+     - Missing data is expected behavior with most updates as updates often include database version update which require an import of data
+
+### Migrate data
+1. Notice that your old data is not available after an update 
+1. Open the new version of KeepTime
+1. Open `Settings` -> `Import/Export` -> `Import` and import the previously exported .sql file 
+1. After the import KeepTime closes automatically
+1. Start KeepTime
+1. Your data is restored in the new version now
+
+### Migrate from version older than v1.2.0
 
 1. Download new version and replace the .jar file.
 2. Start new version of KeepTime. Notice that your old data is not available.
 3. Stop KeepTime
 4. Copy the files (not directories) of directory `db` (next to the .jar file) into `db/1.4.197/` (path now includes the database version).
 5. Start KeepTime again. Notice that your data is available again.
 
-### Migrate from KeepTime v1.2.0
-
-1. Start your current version of KeepTime (v1.2.0)
-2. Go to the settings and export your KeepTime data 
-3. Download new version and replace the .jar file. 
-4. Start new version of KeepTime. Notice that your old data is not available. 
-5. Open the new version and import the exported sql script 
-6. After the import KeepTime closes automatically
-7. To see the changes just start the new KeepTime again
-
 ## Requirements
-
-* Windows 7, 10
-* Linux (tested on Ubuntu 18.04)
-* Java 11
+* Operating System
+  * Windows 7, 10, 11
+  * Linux (tested on Ubuntu 18.04)
+  * Mac (tested on MacBook M2 Pro (ARM based CPU))
+* Java >= 17