Merge branch 'release/0.6.0' into master

beatngu13 · Nov 1, 2020 · fd3cbf6 · fd3cbf6
2 parents ba31b2b + cab158b
commit fd3cbf6
Show file tree

Hide file tree

Showing 21 changed files with 282 additions and 273 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,33 +7,29 @@ assignees: beatngu13
 
 ---
 
-### Describe the Bug
+### Expected Behavior
 
-A clear and concise description of what the bug is.
+A clear and concise description of what you expected to happen.
 
-### To Reproduce
+### Actual Behavior
 
-If possible, please provide a sample PDF and describe the steps to reproduce the behavior:
+A clear and concise description of what the bug is.
 
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+### Steps to Reproduce
 
-### Expected Behavior
+If possible, please provide a sample PDF and describe the steps to reproduce the behavior:
 
-A clear and concise description of what you expected to happen.
+1. Go to ...
+2. Click on ...
+3. Scroll down to ...
+4. See error ...
 
 ### Log
 
-Add the log file from `${HOME}/.pdfzoomwizard/log.txt`.
+Add the [log file](https://github.com/beatngu13/pdf-zoom-wizard/wiki#info) from `${HOME}/.pdfzoomwizard/log.txt`.
 
-### Desktop
+### Environment
 
  - OS: [e.g. macOS 10.14.2]
- - Java version: [e.g. result of `java -version`]
+ - Java version: [e.g. result of `$ java -version`]
  - PDF Zoom Wizard version: [e.g. 1.2.3]
-
-### Additional Context
-
-Add any other context about the problem here.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+  - package-ecosystem: maven
+    directory: "/"
+    schedule:
+      interval: weekly
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,51 +2,60 @@ name: Main build
 
 on: push
 
-env:
-  SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - name: Check out repo
-      uses: actions/checkout@v2
-
-      # fetch unshallow to enable blame for Sonar
-    - name: Fetch unshallow
-      run: |
-        git fetch --prune --unshallow
-
-    - name: Set up JDK 8 with JavaFX
-      uses: actions/setup-java@v1
-      with:
-        java-version: 8
-        java-package: jdk+fx
-
-    - name: Cache Maven
-      uses: actions/cache@v2
-      with:
-        path: ~/.m2/repository/
-        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-        restore-keys: |
-          ${{ runner.os }}-maven-
-
-    - name: Cache Sonar
-      uses: actions/cache@v2
-      with:
-        path: ~/.sonar/cache/
-        key: ${{ runner.os }}-sonar
-
-    - name: Install dependencies
-      run: |
-        ./install-deps.sh
-
-    - name: Build with Maven
-      run: >
-        mvn --batch-mode verify sonar:sonar -Pcoverage
-        -Dsonar.host.url=https://sonarcloud.io
-        -Dsonar.organization=beatngu13-github
-        -Dsonar.projectKey=com.github.beatngu13:pdfzoomwizard
+      - name: Check out repo
+        uses: actions/checkout@v2
+        with:
+          # fetch unshallow to enable blame for Sonar
+          fetch-depth: 0
+
+      - name: Set up JDK 8 with JavaFX
+        uses: actions/setup-java@v1
+        with:
+          java-version: 8
+          java-package: jdk+fx
+
+      - name: Cache Maven
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository/
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}-${{ secrets.CACHE_VERSION }}
+
+      - name: Cache Sonar
+        uses: actions/cache@v2
+        with:
+          path: ~/.sonar/cache/
+          key: ${{ runner.os }}-sonar-${{ secrets.CACHE_VERSION }}
+
+      - name: Install dependencies
+        run: |
+          ./install-deps.sh
+
+      - name: Compile code
+        run: >
+          mvn test-compile -B
+
+      - name: Run tests
+        run: >
+          mvn verify -B
+
+      # required by Sonar
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+
+      - name: Analyze code
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: >
+          mvn sonar:sonar -B
+          -Pcoverage
+          -Dsonar.host.url=https://sonarcloud.io
+          -Dsonar.organization=beatngu13-github
+          -Dsonar.projectKey=com.github.beatngu13:pdfzoomwizard
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,58 @@
+name: Deploy release
+
+on:
+  push:
+    tags: v*
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v2
+
+      - name: Set up JDK 8 with JavaFX
+        uses: actions/setup-java@v1
+        with:
+          java-version: 8
+          java-package: jdk+fx
+
+      - name: Cache Maven
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository/
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Install dependencies
+        run: |
+          ./install-deps.sh
+
+      - name: Package artifact
+        id: package
+        run: |
+          mvn package -B -DskipTests
+          cd ./target/
+          echo "::set-output name=jar_name::$(echo pdfzoomwizard-*.jar)"
+
+      - name: Create release
+        id: create_release
+        uses: actions/create-release@v1
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: true
+
+      - name: Upload release asset
+        id: upload_release_asset
+        uses: actions/upload-release-asset@v1
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./target/${{ steps.package.outputs.jar_name }}
+          asset_name: ${{ steps.package.outputs.jar_name }}
+          asset_content_type: application/java-archive
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ### Security
 
+## [0.6.0] - 2020-11-01
+
+### Changed
+
+- Copy PDF files as default (see [#157](https://github.com/beatngu13/pdf-zoom-wizard/issues/157)).
+
 ## [0.5.1] - 2020-07-23
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -4,28 +4,25 @@
 
 # PDF Zoom Wizard
 
-A new and extended implementation of the [PDF Bookmark Wizard](https://bitbucket.org/beatngu13/pdfbookmarkwizard/) for bookmarks *and* links (work in progress).
+A new and extended implementation of the [PDF Bookmark Wizard](https://bitbucket.org/beatngu13/pdfbookmarkwizard/) for bookmarks *and* links (work in progress) zoom settings. Check out the [wiki](https://github.com/beatngu13/pdf-zoom-wizard/wiki/) to see how to get started.
 
-The [road map](#technical-road-map) below shows the current project status from a technical point of view. Release `v0.1.0` is a simple GitHub port of the former PDF Bookmark Wizard (`v0.0.4.1`) that offers the same functionality. Have a look at the [changelog](https://github.com/beatngu13/pdf-zoom-wizard/blob/master/CHANGELOG.md) for the changes in subsequent releases.
+## (Technical) Road Map
 
-To see how to get started, check out the [wiki](https://github.com/beatngu13/pdf-zoom-wizard/wiki/).
-
-## Technical Road Map
+The road map below shows the current project status from a technical point of view. Have a look at the [changelog](https://github.com/beatngu13/pdf-zoom-wizard/blob/master/CHANGELOG.md) for more details on past changes.
 
 - [x] Convert to Maven project
-- [x] Enhance build process with Travis CI
+- [x] Enhance build process with GitHub Actions
 - [x] Add changelog and Semantic Versioning
 - [x] Tests (!)
+- [x] Add ControlsFX for (modal) dialogs
+- [x] Offer dynamically resizing GUI content
 - [x] Improve logging using SLF4J and Logback
-- [ ] Refactor entire project
+- [x] Refactor entire project
+- [ ] Create self-contained app with OpenJDK 14+
 - [ ] Extract Wizard interface for new implementation (e.g. with [iText](https://itextpdf.com/) or [PDFBox](https://pdfbox.apache.org/))
 - [ ] Implement zoom settings for links
 - [ ] Implement command-line interface (CLI)
 - [ ] Add integration tests for GUI and CLI
-- [ ] Create self-contained app
-- [ ] Migrate to current OpenJDK
-- [x] Add ControlsFX for (modal) dialogs
-- [x] Offer dynamically resizing GUI content
 
 ## Donation