Merge pull request #156 from doubleSlashde/release/v1.3

Release/v1.3

Author: Death111

.github/workflows/mavenCi.yml

@@ -0,0 +1,77 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ "master", "develop" ]
+  pull_request:
+    branches: [ "master", "develop" ]
+  workflow_dispatch: # Allows you to run this workflow manually from the Actions tab
+  schedule:
+    - cron: "0 8 * * 1" #Runs pipeline once a week https://jasonet.co/posts/scheduled-actions/
+
+jobs:
+
+  build-analyze:
+
+    runs-on: ubuntu-latest
+
+    env:
+      version: 1.3.${{ github.run_number }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'corretto'
+          cache: maven
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        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
+        with:
+          name: KeepTime-${{ env.version }}
+          path: /home/runner/work/KeepTime/KeepTime/target/*-bin.zip
+
+      - name: Analyze
+        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
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+
+  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

.mvn/wrapper/maven-wrapper.jar

@@ -1 +1,18 @@
-distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.3/apache-maven-3.5.3-bin.zip
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.1/apache-maven-3.8.1-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

.mvn/wrapper/maven-wrapper.properties

@@ -2,7 +2,30 @@
 
 All notable changes to this project will be documented in this file.
 
-## v1.2.0 - yyyy-mm-dd
+## v1.3.x - 2023-02-14
+
+### Added 
+- option to show note reminder only when switching from a work project without notes
+- option to show a 'are you sure' confirmation before closing KeepTime
+- import functionality of database (to be used with an export of the export functionality)
+- app icon shown in dialogs
+- in the report a collapse / expand button was added
+
+### Changed
+- updated the settings dialog design
+- replaced deprecated fontawesome dependencies
+- updated dependencies - we now also require Java 11 (instead of 8). **note** migration of data of previous version. see section 'Migrate from old version' in readme before updating
+- when creating a new project 'isWork' is selected by default
+- when editing a note the note field will be in focus instead of the project
+- in the report dialog the currently active work item is not editable anymore (marked as 'active work' instead)
+- in report dialog simplified the note format when copying them (removed the note count)
+- when creating/editing a project the name cannot be empty anymore
+- moved CI to github actions
+
+### Fixed 
+- 'hide projects' setting was not working correctly on linux. we disabled the setting for linux
+
+## v1.2.0 - 2021-04-14
 
 ### Added
 

CHANGELOG.md

@@ -12,13 +12,13 @@ Create projects and choose if they are counted as 'work time'. Select the projec
 + You can move the window by dragging it around
 + Open the context menu (with a right-click) for a project to edit/delete or change the project and transfer n minutes of the current running one
 + In the taskbar you will also see the current time + the color of the active project
-+ The current Project will be saved eyery minute to mitigate loss on system crash or shutdown without closing window manually first. 
++ The current Project will be saved every minute to mitigate loss on system crash or shutdown without closing window manually first. 
 + After a day you can open the Reports, which will summarize the work done for the different projects during the day
 
-**You need to close the application manualy before you shutdown your PC. Otherwise the last running project is not saved completely to database. (will be last state saved by auto-save)**
+**You need to close the application manually before you shut down your PC. Otherwise, the last running project is not saved completely to database. (will be last state saved by auto-save)**
 
 ### Settings:
-![Settings Screen](readme/images/settings.png?raw=true "Settings")
+![Settings Screen](readme/images/settingsColor.PNG?raw=true "Settings")
 
 + Colors: you can define various colors to use in the UI to customize the application. The Reset resets the color to the default color.
 + Display projects on the right: Will show the list of projects on the right side, instead of the left
@@ -37,24 +37,34 @@ Create projects and choose if they are counted as 'work time'. Select the projec
 
 * Download keeptime.bat and keeptime-<version>-bin.zip (see [releases](https://github.com/doubleSlashde/KeepTime/releases))
 * Extract the downloaded .zip
-* Copy the downloaded keeptime.bat file next to the *.jar*. Adapt the path inside the *keeptime.bat* to the name of the *.jar* file (if needed). Try starting the application by executing the *keeptime.bat* file. The start may take up to one minute.
+* Try starting the application by executing the *keeptime.bat* file. The start may take up to one minute.
 
-It is recommended to run the application at computer start so you do not forget to track your time. For autostart also execute the following steps (for windows)
+It is recommended to run the application at computer start, so you do not forget to track your time. For autostart also execute the following steps (for windows)
 * Open the autostart folder: Press *Windows+R*, execute *shell:startup*
 * Create a shortcut to the *.bat* in the autostart folder
 
 You should put the .jar in an extra folder as a *logs* and a *db* folder will be created next to it.\
 
-### Migrate from old version
+### Migrate from older version 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 8 + JavaFX
+* Java 11

README.md

@@ -4,7 +4,7 @@
   <id>bin</id>
 
   <formats>
-  	<format>zip</format>
+    <format>zip</format>
   </formats>
 
   <includeBaseDirectory>false</includeBaseDirectory>
@@ -15,12 +15,19 @@
       <outputDirectory>licenses</outputDirectory>
     </fileSet>
   </fileSets>
+  <files>
+    <file>
+      <source>${project.basedir}/keeptime.bat</source>
+    </file>
+  </files>
 
   <dependencySets>
     <dependencySet>
       <includes>
         <include>de.doubleslash:keeptime</include>
       </includes>
+      <!-- default value is ${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.extension} - #152 removed version-->
+      <outputFileNameMapping>${artifact.artifactId}.${artifact.extension}</outputFileNameMapping>
     </dependencySet>
   </dependencySets>
 </assembly>

assembly.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<suppressions xmlns="https://jeremylong.github.io/DependencyCheck/dependency-suppression.1.3.xsd">
+   <suppress>
+      <notes>
+      <![CDATA[
+      file name: maven-core-3.0.jar
+      suppression-reason: referenced from 'maven-assembly-plugin' which is executed in build step (no runtime vulnerability). no assembly-plugin update available.
+      ]]>
+      </notes>
+      <packageUrl regex="true">^pkg:maven/org\.apache\.maven/maven\-core@.*$</packageUrl>
+      <cve>CVE-2021-26291</cve>
+   </suppress>
+   <suppress>
+      <notes>
+      <![CDATA[
+      file name: maven-settings-3.0.jar
+      suppression-reason: referenced from 'maven-assembly-plugin' which is executed in build step (no runtime vulnerability). no assembly-plugin update available.
+      ]]>
+      </notes>
+      <packageUrl regex="true">^pkg:maven/org\.apache\.maven/maven\-settings@.*$</packageUrl>
+      <vulnerabilityName>CVE-2021-26291</vulnerabilityName>
+   </suppress>
+   <suppress>
+      <notes>
+      <![CDATA[
+      file name: snakeyaml-1.30.jar
+      suppression-reason: we are not using .yaml files
+      ]]>
+      </notes>
+      <packageUrl regex="true">^pkg:maven/org\.yaml/snakeyaml@.*$</packageUrl>
+      <cve>CVE-2022-1471</cve>
+   </suppress>
+</suppressions>

dependency-check-report_suppressions.xml

@@ -0,0 +1,26 @@
+#!/bin/bash
+H2_VERSION=1.4.197
+DB_URL=jdbc:h2:file:./db/$H2_VERSION/keeptime-h2-db;DB_CLOSE_ON_EXIT=FALSE
+DB_USER=sa
+DB_PASSWD=
+SQL_BACKUP_FILENAME=KeepTime_database-export_H2-version-$H2_VERSION.sql
+
+echo "Script to export the content of H2 databse from KeepTime version 1.2.0-SNAPSHOT to .sql file."
+echo "The script should be placed next to the .jar file."
+read -p "Press enter to continue"
+
+echo -e "\nExtracting H2 driver from KeepTime .jar file."
+DRIVER_JAR_FROM_KEEPTIME=BOOT-INF/lib/h2-$H2_VERSION.jar
+jar xfv keeptime-1.2.0-SNAPSHOT.jar $DRIVER_JAR_FROM_KEEPTIME
+
+echo -e "\nTriggering database backup."
+java -cp $DRIVER_JAR_FROM_KEEPTIME org.h2.tools.Script -url $DB_URL -user $DB_USER -script $SQL_BACKUP_FILENAME -options DROP
+
+echo -e "\nCleanup of extracted .jar file."
+rm -rv BOOT-INF
+
+echo -e "\nIf no error occured the export has succeeded."
+echo "The exported file was created at '$(pwd)/$SQL_BACKUP_FILENAME'."
+echo -e "\nYou can now import this file in a new version of KeepTime.\n"
+
+read -p "All set. Press enter to exit script."

exportScriptForLinux/createBackupForLinux.sh

@@ -1 +1 @@
-start "" "javaw" -Dprism.order=sw -jar keeptime-1.2.0-SNAPSHOT.jar
+start "" "javaw" -Dprism.order=sw -jar keeptime.jar