License audit Docker image

Run analysis locally

1. Pull the image from Docker Hub (necessary to use the latest version):

docker pull jetbrains/qodana-license-audit

2. Run the following command:

docker run --pull always --rm -it -p 8080:8080 \
    -v <source-directory>/:/data/project \
    -v <output-directory>/:/data/results \
    jetbrains/qodana-license-audit --show-report

where <source-directory< and <output-directory> are full local paths to the directories that contain, respectively, the project source code and the analysis results.

This command runs the analysis on your source code and starts the web server to provide a convenient view of the results. Open http://localhost:8080 in your browser to examine the found problems and performed checks. Here, you can also reconfigure the analysis. See the UI section of this guide for details. When done, you can stop the web server by pressing Ctrl-C in the Docker console.

If you don't need the user interface and prefer to study raw data, use the following command:

docker run --rm -it \
    -v <source-directory>/:/data/project/ \
    -v <output-directory>/:/data/results/ \
    jetbrains/qodana-license-audit

If you run the analysis several times in a row, make sure you've cleaned the results directory before using it in docker run again.

By default, Qodana License audit comes with a set of pre-installed tools versions (Java 11, Gradle 6, Python 3 and others), you can explicitly specify which tool versions to use for your project.

docker run --rm -it \
    -e <language-version> =3.7.10
    -v <source-directory>/:/data/project/ \
    -v <output-directory>/:/data/results/ \
    jetbrains/qodana-license-audit

See technical guide for details.

Run analysis in CI

• Run the following command as a task in a generic Shell executor:

docker run --rm -it \
    -v <source-directory>/:/data/project/ \
    -v <output-directory>/:/data/results/ \
    jetbrains/qodana-license-audit

where <source-directory< and <output-directory> are full local paths to the directories that contain, respectively, the project source code and the analysis results.

Consider using fail-threshold to make the build fail on reaching a certain number of problems. Running as non-root is also supported.

• Example for GitHub Workflow (.github/workflows/qodana-license-audit.yml):

name: Qodana - License audit
on:
  workflow_dispatch:
jobs:
  qodana:
    runs-on: ubuntu-latest
    steps:
      # clone your project
      - uses: actions/checkout@v2
      # run qodana-license-audit
      - name: Qodana - License audit
        uses: jetbrains/qodana-license-audit-action@main
        with:
          options: PYTHON_VERSION=3.7.10
      # upload the results to GitHub artifacts
      - uses: actions/upload-artifact@v2
        with:
          path: ${{ github.workspace }}/qodana