v5.0.2

.github/workflows/actions.yml

@@ -0,0 +1,64 @@
+name: 'actions-build-test'
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+    branches:
+      - main
+      - 'releases/*'
+
+jobs:
+  check-dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set Node.js 12.x
+        uses: actions/setup-node@v2.5.1
+        with:
+          node-version: 12.x
+      - name: Install dependencies
+        run: cd scan && npm ci && cd ../common && npm ci
+      - name: Rebuild the dist/ directory
+        run: cd scan && npm run build && npm run package
+      - name: Compare the expected and actual dist/ directories
+        run: |
+          if [ "$(git diff --ignore-space-at-eol scan/dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build.  See status below:"
+            git diff
+            exit 1
+          fi
+        id: diff
+      # If index.js was different from expected, upload the expected version as an artifact
+      - uses: actions/upload-artifact@v2
+        if: ${{ failure() && steps.diff.conclusion == 'failure' }}
+        with:
+          name: dist
+          path: scan/dist/
+
+  build: # make sure build/ci work properly
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ macos-latest, ubuntu-latest, windows-latest ]
+    steps:
+      - uses: actions/checkout@v3
+      - run: |
+          cd scan
+          npm install
+          npm test
+
+  test-ubuntu: # make sure the action works on a clean machine without building
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./
+        with:
+          args: --linter,jetbrains/qodana-js
+
+#   Not possible at the moment for GitHub-hosted Windows agents: https://github.com/JetBrains/qodana-action/pull/31#issue-812728409
+#   test-windows:
+#     runs-on: windows-latest
+#     steps:
+#       - uses: actions/checkout@v3
+#       - uses: ./
+#         with:
+#           linter: jetbrains/qodana-js

.github/workflows/vsts.yml

@@ -0,0 +1,45 @@
+name: vsts-build-test
+on:
+  pull_request: null
+  push:
+    branches:
+      - main
+      - releases/*
+jobs:
+  build:
+    runs-on: '${{ matrix.os }}'
+    strategy:
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: cd common && npm ci && cd ../vsts && npm install && npm run build
+  check-dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set Node.js 12.x
+        uses: actions/setup-node@v2.5.1
+        with:
+          node-version: 12.x
+      - name: Install dependencies
+        run: cd vsts && npm ci && cd ../common && npm ci
+      - name: Rebuild the QodanaScan/ directory
+        run: cd vsts && npm run build && npm run package
+      - name: Compare the expected and actual QodanaScan/ directories
+        run: >
+          if [ "$(git diff --ignore-space-at-eol vsts/QodanaScan/ | wc -l)" -gt
+          "0" ]; then
+            echo "Detected uncommitted changes after build.  See status below:"
+            git diff
+            exit 1
+          fi
+        id: diff
+      - uses: actions/upload-artifact@v2
+        if: '${{ failure() && steps.diff.conclusion == ''failure'' }}'
+        with:
+          name: dist
+          path: vsts/QodanaScan/

.gitignore

@@ -1,5 +1,7 @@
 # Dependency directory
 node_modules
+**/node_modules
+**/lib
 .idea
 # Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs
@@ -95,5 +97,7 @@ typings/
 Thumbs.db
 
 # Ignore built ts files
-__tests__/runner/*
-lib/**/*
+scan/__tests__/runner/*
+lib/**/*
+
+vsts/QodanaScan/.taskkey

README.md

@@ -5,10 +5,7 @@
 [![Twitter Follow](https://img.shields.io/twitter/follow/Qodana?style=social&logo=twitter)][jb:twitter]
 
 **Qodana** is a code quality monitoring tool that identifies and suggests fixes for bugs, security vulnerabilities,
-duplications, and imperfections. Using this GitHub Action, run Qodana with your GitHub workflow to scan your Java,
-Kotlin, PHP, Python, JavaScript, TypeScript projects (
-and [other supported technologies by Qodana](https://www.jetbrains.com/help/qodana/supported-technologies.html)).
-
+duplications, and imperfections. 
 **Table of Contents**
 
 <!-- toc -->
@@ -21,6 +18,8 @@ and [other supported technologies by Qodana](https://www.jetbrains.com/help/qoda
 
 <!-- tocstop -->
 
+> 💡 This README is about Qodana Scan GitHub action. To learn more about Qodana for Azure Pipelines, please visit [./vsts/README.md](./vsts/README.md).
+
 ## Usage
 
 ### Basic configuration
@@ -41,16 +40,13 @@ jobs:
   qodana:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: 'Qodana Scan'
-        uses: JetBrains/qodana-action@v4.2.2
-        with:
-          linter: jetbrains/qodana-<linter>
+        uses: JetBrains/qodana-action@experimental
 ```
 
 Using this workflow, Qodana will run on the main branch, release branches, and on the pull requests coming to your
-repository. Inspection results will be available in the GitHub UI. The `jetbrains/qodana-<linter>` option specifies a
-[Qodana linter](linters.md).
+repository. 
 
 We recommend that you have a separate workflow file for Qodana
 because [different jobs run in parallel](https://help.github.com/en/actions/getting-started-with-github-actions/core-concepts-for-github-actions#job)
@@ -102,8 +98,6 @@ Instead of `main`, you can specify your branch here.
 9. Search for the `Qodana` status check, then check it.
 10. Click **Create**.
 
-<anchor name="github-actions-quality-gate-baseline"/>
-
 ### Quality gate and baseline
 
 You can combine the [quality gate](quality-gate.xml) and [baseline](qodana-baseline.xml) features to manage your
@@ -114,8 +108,8 @@ Follow these steps to establish a baseline for your project:
 1. Run Qodana [locally](docker-images.md) over your project:
 
 ```shell
-docker run --rm -v <source-directory>/:/data/project/ \
-  -p 8080:8080 jetbrains/qodana-<linter> --show-report
+cd <source-directory>
+qodana scan --show-report
 ```
 
 2. Open your report at `http://localhost:8080/`, [add detected problems](ui-overview.md#Technical+debt) to the baseline,
@@ -126,7 +120,7 @@ docker run --rm -v <source-directory>/:/data/project/ \
 4. Append this line to the Qodana Scan action configuration in the `code_quality.yml` file:
 
 ```yaml
-baseline-path: qodana.sarif.json; 
+baseline-path: qodana.sarif.json
 ```
 
 If you want to update the baseline, you need to repeat these steps once again.
@@ -176,31 +170,19 @@ To do it, follow these steps:
 
 ## Configuration
 
-| Name                       | Description                                                                                                                        | Default Value                           |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|
-| `linter`                   | [Official Qodana Docker image](https://www.jetbrains.com/help/qodana/docker-images.html). Required.                                | `jetbrains/qodana-jvm-community:latest` |
-| `project-dir`              | The project's root directory to be analyzed. Optional                                                                              | `${{ github.workspace }}`               |
-| `results-dir`              | Directory to store the analysis results. Optional.                                                                                 | `${{ runner.temp }}/qodana/results`     |
-| `cache-dir`                | Directory to store Qodana caches. Optional.                                                                                        | `${{ runner.temp }}/qodana/caches`      |
-| `idea-config-dir`          | IntelliJ IDEA configuration directory. Optional.                                                                                   | -                                       |
-| `gradle-settings-path`     | Provide path to gradle.properties file. An example: "/your/custom/path/gradle.properties". Optional.                               | -                                       |
-| `additional-volumes`       | Mount additional volumes to Docker container. Multiline input variable: specify multiple values with newlines. Optional.                                                                            | -                                       |
-| `additional-env-variables` | Pass additional environment variables to docker container. Multiline input variable: specify multiple values with newlines. Optional.                                                               | -                                       |
-| `fail-threshold`           | Set the number of problems that will serve as a quality gate. If this number is reached, the pipeline run is terminated. Optional. | -                                       |
-| `inspected-dir`            | Directory to be inspected. If not specified, the whole project is inspected by default. Optional.                                  | -                                       |
-| `baseline-path`            | Run in baseline mode. Provide the path to an existing SARIF report to be used in the baseline state calculation. Optional.         | -                                       |
-| `baseline-include-absent`  | Include the results from the baseline absent in the current Qodana run in the output report. Optional.                             | `false`                                 |
-| `changes`                  | Inspect uncommitted changes and report new problems. Optional.                                                                     | `false`                                 |
-| `script`                   | Override the default docker scenario. Optional.                                                                                    | -                                       |
-| `profile-name`             | Name of a profile defined in the project. Optional.                                                                                | -                                       |
-| `profile-path`             | Absolute path to the profile file. Optional.                                                                                       | -                                       |
-| `token`                    | Qodana Cloud token, if specified, the report will be sent to Qodana Cloud. Optional.                                                  | -                                       |
-| `upload-result`            | Upload Qodana results as an artifact to the job. Optional.                                                                         | `true`                                  |
-| `artifact-name`            | Specify Qodana results artifact name, used for results uploading. Optional.                                                        | `Qodana report`                                  |
-| `use-caches`               | Utilize GitHub caches for Qodana runs. Optional.                                                                                   | `true`                                  |
-| `additional-cache-hash`    | Allows customizing the generated cache hash. Optional.                                                                             |                                         `${{ github.sha }}` |
-| `use-annotations`          | Use annotation to mark the results in the GitHub user interface. Optional.                                                         | `true`                                  |
-| `github-token`             | GitHub token to be used for uploading results. Optional.                                                                           | `${{ github.token }}`                   |
+Most likely you won't need other options than `args`: all other options can be useful if you are configuring multiple Qodana Scan jobs in one workflow.
+
+| Name                      | Description                                                                                                                                                                           | Default Value                       |
+|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
+| `args`                    | Additional [Qodana CLI `scan` command](https://github.com/jetbrains/qodana-cli#scan) arguments, split the arguments with commas (`,`), e.g. `-i,frontend,--print-problems`. Optional. | -                                   |
+| `results-dir`             | Directory to store the analysis results. Optional.                                                                                                                                    | `${{ runner.temp }}/qodana/results` |
+| `upload-result`           | Upload Qodana results as an artifact to the job. Optional.                                                                                                                            | `true`                              |
+| `artifact-name`           | Specify Qodana results artifact name, used for results uploading. Optional.                                                                                                           | `qodana-report`                     |
+| `cache-dir`               | Directory to store Qodana cache. Optional.                                                                                                                                            | `${{ runner.temp }}/qodana/caches`  |
+| `use-caches`              | Utilize GitHub caches for Qodana runs. Optional.                                                                                                                                      | `true`                              |
+| `additional-cache-hash`   | Allows customizing the generated cache hash. Optional.                                                                                                                                | `${{ github.sha }}`                 |
+| `use-annotations`         | Use annotation to mark the results in the GitHub user interface. Optional.                                                                                                            | `true`                              |
+| `github-token`            | GitHub token to be used for uploading results. Optional.                                                                                                                              | `${{ github.token }}`               |
 
 ## Issue Tracker