Merge pull request #1110 from Dockbox-OSS/develop/0.6.0

Release candidate 0.6.0 (RC1)

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,32 @@
+name: 'Bug report'
+description: 'If you found a bug in the project, please create an issue here.'
+labels: ['type: bug']
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: 'Description'
+      description: 'Provide a clear and concise description of the bug you found.'
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: 'Reproduction'
+      description: 'Describe the steps to reproduce the bug, if applicable.'
+    validations:
+      required: false
+  - type: textarea
+    id: expected
+    attributes:
+      label: 'Expected behavior'
+      description: 'Describe what you expected to happen.'
+    validations:
+      required: true
+  - type: input
+    id: related
+    attributes:
+      label: 'Related issues'
+      description: 'If applicable, list any related issues here.'
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/chore.yml

@@ -0,0 +1,18 @@
+name: 'Maintenance chore'
+description: 'Any issues related to maintenance tasks, such as refactoring or updating dependencies.'
+labels: ['type: chore']
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: 'Description'
+      description: 'Provide a clear and concise description of the maintenance task.'
+    validations:
+      required: true
+  - type: input
+    id: related
+    attributes:
+      label: 'Related issues'
+      description: 'If applicable, list any related issues here.'
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,29 @@
+name: 'Documentation'
+description: 'Any issues related to documentation, such as missing or incorrect information.'
+labels: ['type: documentation']
+body:
+  - type: dropdown
+    id: type
+    attributes:
+      label: 'Type'
+      description: 'What type of documentation issue is this?'
+      options:
+        - 'Missing information'
+        - 'Incorrect information'
+        - 'Other'
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: 'Description'
+      description: 'Provide a clear and concise description of the documentation issue.'
+    validations:
+      required: true
+  - type: input
+    id: related
+    attributes:
+      label: 'Related issues'
+      description: 'If applicable, list any related issues here.'
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -1,19 +1,12 @@
-name: 'Enhancement'
-description: 'If you want to improve an already existing feature, please create an issue here.'
-labels: ['type: enhancement']
+name: 'Enhancement (of existing feature)'
+description: 'Propose an enhancement to an existing feature.'
+labels: [ 'type: enhancement' ]
 body:
   - type: textarea
     id: description
     attributes:
       label: 'Description'
-      description: "Provide a clear and concise description of the enhancement you'd like to request for existing functionality."
-    validations:
-      required: true
-  - type: textarea
-    id: current
-    attributes:
-      label: 'Current behavior'
-      description: "Describe the current behavior or functionality that you believe needs improvement or enhancement."
+      description: "Provide a clear and concise description of the enhancement you'd like to propose."
     validations:
       required: true
   - type: textarea
@@ -23,31 +16,10 @@ body:
       description: 'Explain the use case or scenario where this enhancement would be valuable or necessary.'
     validations:
       required: true
-  - type: textarea
-    id: expected
-    attributes:
-      label: 'Expected behavior'
-      description: 'Describe what you expect the enhanced functionality to do and how it should work.'
-    validations:
-      required: true
-  - type: textarea
-    id: additional
-    attributes:
-      label: 'Additional context'
-      description: 'Add any other context or screenshots about the feature request here.'
-    validations:
-      required: false
   - type: input
     id: related
     attributes:
       label: 'Related issues'
       description: 'If applicable, list any related issues here.'
     validations:
       required: false
-  - type: textarea
-    id: implementations
-    attributes:
-      label: 'Possible implementations'
-      description: 'If you have any ideas on how this feature could be implemented, please include them here.'
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/feature_request.yml → .github/ISSUE_TEMPLATE/feature.yml

@@ -1,5 +1,5 @@
 name: 'Feature request'
-description: 'If you want to add a feature to the project, please create an issue here.'
+description: 'Propose a new feature, that does not directly relate to existing functionality.'
 labels: ['type: feature request']
 body:
   - type: textarea
@@ -16,24 +16,10 @@ body:
       description: 'Explain the use case or scenario where this feature would be valuable or necessary.'
     validations:
       required: true
-  - type: textarea
-    id: additional
-    attributes:
-      label: 'Additional context'
-      description: 'Add any other context or screenshots about the feature request here.'
-    validations:
-      required: false
   - type: input
     id: related
     attributes:
       label: 'Related issues'
       description: 'If applicable, list any related issues here.'
     validations:
       required: false
-  - type: textarea
-    id: implementations
-    attributes:
-      label: 'Possible implementations'
-      description: 'If you have any ideas on how this feature could be implemented, please include them here.'
-    validations:
-      required: false

.github/workflows/build_modules.yml → .github/workflows/build.modules.yml

@@ -1,6 +1,6 @@
 name: Build all
 
-on: pull_request
+on: [pull_request, workflow_dispatch]
 
 jobs:
   buildSource:
@@ -14,4 +14,4 @@ jobs:
           java-version: 21
           distribution: temurin
       - name: "Build (source JDK)"
-        run: mvn clean install -DskipTests -P ci,all
+        run: mvn clean install -DskipTests -P ci,all

.github/workflows/check.codestyle.yml

@@ -0,0 +1,18 @@
+name: Checkstyle
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  depCheck:
+    name: Checkstyle
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v3
+        with:
+          java-version: 21
+          distribution: temurin
+      - name: Check code style
+        run: mvn clean install -DskipTests -P ci,all -Dcheckstyle.skip=false

.github/workflows/dependency_check.yml → .github/workflows/check.dependency.yml

@@ -1,6 +1,6 @@
 name: OWASP Dependency Check
 
-on: pull_request
+on: [pull_request, workflow_dispatch]
 
 jobs:
   depCheck:
@@ -17,10 +17,10 @@ jobs:
       - name: Prepare for dependency check
         run: mvn clean install -DskipTests -P ci,all
       - name: Analyze dependencies
-        run: mvn dependency-check:check -Dowasp.skip=false -P ci,all
+        run: mvn dependency-check:check -Dowasp.skip=false -DnvdApiKey=${{ secrets.NVD_API_KEY }} -P ci,all
       - name: Archive dependency reports
         uses: actions/upload-artifact@v2
         if: always()
         with:
           name: dependency-check-report
-          path: /hartshorn-*/target/dependency-check-report.html
+          path: /hartshorn-*/target/dependency-check-report.html

.github/workflows/license_check.yml → .github/workflows/check.license.yml

@@ -1,6 +1,6 @@
 name: License header check
 
-on: pull_request
+on: [pull_request, workflow_dispatch]
 
 jobs:
   depCheck:
@@ -9,6 +9,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          # We need the full history to check the year on license headers
+          fetch-depth: 0
       - name: Set up JDK 21
         uses: actions/setup-java@v3
         with:

.github/workflows/test_coverage.yml → .github/workflows/test.coverage.yml

@@ -1,6 +1,6 @@
 name: Tests
 
-on: pull_request
+on: [pull_request, workflow_dispatch]
 
 jobs:
   coverage:
@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-latest, macos-latest]
+        os: [windows-latest, macos-13]
     name: Unit tests (Compatibility, JDK 21, ${{ matrix.os }})
     runs-on: "${{ matrix.os }}"
     steps:

SECURITY.md

@@ -0,0 +1,30 @@
+# Security Policy
+## JAR signing (as of July 2024)
+All JAR files released on Maven Central are signed with the following GPG key:
+```plaintext
+Key ID: [email protected]
+Fingerprint: 6F34 6237 5920 3A7C 0E97 1D9E 979A 72D9 DFAB F6A2
+Key size: RSA 4096
+Date: 2024-07-30T16:53:39Z
+```
+
+You can import this key using the public key server:
+```shell
+$ gpg --keyserver keyserver.ubuntu.com --recv 6F34623759203A7C0E971D9E979A72D9DFABF6A2
+```
+
+## JAR signing (before July 2024)
+JAR files released before July 2024 (up to and including release 0.5.0) were signed with the following GPG key:
+```plaintext
+Key ID: [email protected]
+Fingerprint: CCC8 A24E D300 4EF6 22DE 752E F180 83C0 F99D 2EFB
+Key size: RSA 4096
+Date: 2021-11-11T18:13:20Z
+```
+
+```shell
+$ gpg --keyserver keyserver.ubuntu.com --recv CCC8A24ED3004EF622DE752EF18083C0F99D2EFB
+```
+
+> [!NOTE]
+> You can find a permanent copy of this notice at https://dockbox.org/gpg-key-hartshorn.txt