Qodana 2021.1 Help

Qodana License Audit Docker Image

official JetBrains project Docker Stars Docker Pulls

Supported tags: 2021.1-eap, latest (points to 2021.1-eap)

We provide a Docker image for the License Audit linter to support different usage scenarios:

  • Running the analysis on a regular basis as part of your continuous integration (CI-based execution ).

  • Single-shot analysis (for example, performed locally ).

Quick start

Run analysis locally

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

docker pull jetbrains/qodana-license-audit
  1. 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

The <output-directory> will contain all the necessary results. You can further tune the command as described in the technical guide.

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.

The content of <output-directory> is described in License Audit Output. 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

Usage statistics

According to the JetBrains EAP user agreement, we can use third-party services to analyze the usage of our features to further improve the user experience. All data will be collected anonymously. You can disable the reporting of usage statistics by adjusting the options of the Docker command you use. Refer to the technical guide for details.

License

By using Qodana Clone Finder Docker image, you agree to the JetBrains EAP user agreement and JetBrains privacy policy.

Last modified: 05 July 2021