Merge pull request #42 from nordic-institute/release-0.6

chore:  0.6.0 release

.github/workflows/build.yml

@@ -0,0 +1,79 @@
+name: Build and test
+on:
+  # Capture this event so that gradle caches are updated when a PR is merged to develop
+  # More information on why: https://github.com/gradle/gradle-build-action#using-the-caches-read-only
+  push:
+    branches:
+      - develop
+    paths:
+      - 'src/**'
+      - '.github/**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'src/**'
+      - '.github/**'
+permissions:
+  contents: write # Required for https://github.com/gradle/actions/tree/main/setup-gradle#github-dependency-graph-support
+  pull-requests: write # https://github.com/gradle/actions/tree/main/setup-gradle#adding-job-summary-as-a-pull-request-comment
+  actions: read # Required for https://github.com/dorny/test-reporter
+  checks: write # Required for https://github.com/dorny/test-reporter
+# Cancels previous workflow run on PR if a new one is started (does not affect push to develop).
+# This is because github.head_ref is empty on push events so defaults to the unique github.run_id.
+# More info: https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+jobs:
+  BuildAndPackageWithUnitTests:
+    name: Build, test and package code
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # SonarCloud: Shallow clones should be disabled for a better relevancy of analysis
+
+      # Setting up both JDK 11 and 17
+      # 11 is used for compiling and running tests
+      # 17 is required by sonar
+      - name: Set up JDK 11
+        uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
+          gradle-home-cache-cleanup: true
+          dependency-graph: generate-and-submit
+          add-job-summary-as-pr-comment: always
+      - name: Build and test source
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        working-directory: ./src
+        run: ./gradlew build jacocoTestReport sonar -Dsonar.projectKey=nordic-institute_xrd4j -Dsonar.organization=nordic-institute -Dsonar.host.url=https://sonarcloud.io
+      - name: Test report
+        uses: dorny/test-reporter@v1
+        if: success() || failure()
+        with:
+          name: Unit and integration tests
+          path: src/**/build/test-results/**/TEST-*.xml
+          reporter: java-junit
+          list-suites: 'failed'
+          list-tests: 'failed'
+      - name: Build example-adapter
+        working-directory: ./example-adapter
+        run: ./gradlew --include-build ../src build

.gitignore

@@ -1,14 +1,12 @@
 *.class
+.gradle/
+build/
+javadoc/
 
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 example-adapter/.mtj.tmp
 
-# Package Files #
-*.jar
-*.war
-*.ear
-
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 

.ort.yml

@@ -0,0 +1,75 @@
+---
+excludes:
+  paths:
+  - pattern: "3RD-PARTY-NOTICES.txt"
+    reason: "OTHER"
+    comment: "File including 3rd party license notices."
+
+  - pattern: "example-adapter/**"
+    reason: "EXAMPLE_OF"
+    comment: "This directory contains an example app that's not distributed."
+
+  - pattern: "examples/**"
+    reason: "EXAMPLE_OF"
+    comment: "This directory contains examples that are not distributed."
+
+  - pattern: "documentation/**"
+    reason: "DOCUMENTATION_OF"
+    comment: "This directory contains documentation that's not distributed."
+
+  scopes:
+  - pattern: "checkstyle"
+    reason: "BUILD_DEPENDENCY_OF"
+    comment: "Packages for code styling checks (testing) only."
+
+  - pattern: "devDependencies"
+    reason: "DEV_DEPENDENCY_OF"
+    comment: "Packages for development only."
+
+  - pattern: "jacocoAgent"
+    reason: "TEST_DEPENDENCY_OF"
+    comment: "Packages for code coverage (testing) only."
+
+  - pattern: "jacocoAnt"
+    reason: "TEST_DEPENDENCY_OF"
+    comment: "Packages for code coverage (testing) only."
+
+  - pattern: "test.*"
+    reason: "TEST_DEPENDENCY_OF"
+    comment: "Packages for testing only."
+
+  - pattern: "annotationProcessor"
+    reason: "DEV_DEPENDENCY_OF"
+    comment: "Packages for development only."
+
+  - pattern: "compileClasspath"
+    reason: "DEV_DEPENDENCY_OF"
+    comment: "Packages for development only."
+
+  - pattern: "compileOnly"
+    reason: "DEV_DEPENDENCY_OF"
+    comment: "Packages for development only."
+
+  - pattern: "provided"
+    reason: "RUNTIME_DEPENDENCY_OF"
+    comment: "Packages that are provided by the runtime."
+
+license_choices:
+  repository_license_choices:
+    - given: "GPL-2.0-only OR Apache-2.0"
+      choice: "Apache-2.0"
+    - given: "GPL-2.0-only OR BSD-3-Clause"
+      choice: "BSD-3-Clause"
+    - given: "GPL-2.0-only OR CDDL-1.1"
+      choice: "CDDL-1.1"
+    - given: "CDDL-1.1 OR GPL-2.0-only WITH Classpath-exception-2.0"
+      choice: "CDDL-1.1"
+    - given: "GPL-2.0-only OR CDDL-1.0"
+      choice: "CDDL-1.0"
+
+curations:
+  packages:
+    - id: "Maven:com.sun.xml.messaging.saaj:saaj-impl:1.3.28"
+      curations:
+        comment: "The package offers GPL-2.0-only OR CDDL-1.1 and we use the curation to override the choice mechanism due to a pending issue in ORT."
+        concluded_license: "CDDL-1.1"