Skip to content

Update user-manual.adoc #980

Update user-manual.adoc

Update user-manual.adoc #980

# Copyright (c) 2023 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available 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.
#
# SPDX-License-Identifier: Apache-2.0
name: "[BE] OWASP dependency check"
on:
workflow_dispatch: # Trigger manually
pull_request:
env:
REPO_NAME: ${{ github.repository }}
REPO_OWNER: ${{ github.repository_owner }}
REPO_URL: ${{ github.server_url }}/${{ github.repository }}
GHCR_REGISTRY: ghcr.io
JAVA_VERSION: 17
DOCKER_HUB_REGISTRY_NAMESPACE: tractusx
FAIL_BUILD_ON_CVSS: 7
SUPPRESSIONS_FILE: dependency_check/suppressions.xml
jobs:
Dependency-analysis:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
java-version: '${{ env.JAVA_VERSION }}'
distribution: 'temurin'
cache: 'maven'
- name: Run mvn clean install
run: |
mvn -B -DskipTests -pl tx-models,tx-backend -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn\
clean install
- name: Dependency check tx-backend # possible severity values: <'fail'|'warn'|'ignore'>
uses: dependency-check/Dependency-Check_Action@3102a65fd5f36d0000297576acc56a475b0de98d
with:
project: 'tx-backend'
path: 'tx-backend'
format: 'HTML'
out: 'tx-backend/target/depcheck-report.html'
args: >
--failOnCVSS ${{ env.FAIL_BUILD_ON_CVSS }}
--suppression ${{ env.SUPPRESSIONS_FILE }}
env:
# actions/setup-java changes JAVA_HOME, so it needs to be reset to match the depcheck image
JAVA_HOME: /opt/jdk
- name: Dependency check tx-models # possible severity values: <'fail'|'warn'|'ignore'>
uses: dependency-check/Dependency-Check_Action@3102a65fd5f36d0000297576acc56a475b0de98d
with:
project: 'tx-models'
path: 'tx-models'
format: 'HTML'
out: 'tx-models/target/depcheck-report.html'
args: >
--failOnCVSS ${{ env.FAIL_BUILD_ON_CVSS }}
--suppression ${{ env.SUPPRESSIONS_FILE }}
env:
# actions/setup-java changes JAVA_HOME, so it needs to be reset to match the depcheck image
JAVA_HOME: /opt/jdk
- name: Upload results for tx-backend
if: always()
uses: actions/upload-artifact@master
with:
name: Depcheck report tx-backend
path: tx-backend/target/depcheck-report.html
- name: Upload results for tx-models
if: always()
uses: actions/upload-artifact@master
with:
name: Depcheck report tx-models
path: tx-models/target/depcheck-report.html
- name: Add PR comment
uses: mshick/add-pr-comment@v2
if: failure()
with:
message: |
## ‼️ Dependency Check findings ‼️
One or more high/critical findings have been found during dependency check. Please check the depenency report:
${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
- name: Add PR comment
uses: mshick/add-pr-comment@v2
if: success()
with:
message: |
## ✅ No Dependency Check findings were found