✨ Bump dependencies, sync some options with Qodana Docker images

JetBrains · Jan 31, 2022 · 8aae08a · 8aae08a
1 parent 317a376
commit 8aae08a
Show file tree

Hide file tree

Showing 10 changed files with 406 additions and 230 deletions.
diff --git a/README.md b/README.md
@@ -4,17 +4,20 @@
 [![GitHub Discussions](https://img.shields.io/github/discussions/jetbrains/qodana)][jb:discussions]
 [![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)).
+**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)).
 
 **Table of Contents**
 
 <!-- toc -->
 
 - Qodana Scan
-  - [Usage](#usage)
-  - [Configuration](#configuration)
-  - [Issue Tracker](#issue-tracker)
-  - [License](#license)
+    - [Usage](#usage)
+    - [Configuration](#configuration)
+    - [Issue Tracker](#issue-tracker)
+    - [License](#license)
 
 <!-- tocstop -->
 
@@ -45,43 +48,47 @@ jobs:
           linter: jetbrains/qodana-<linter>
 ```
 
-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 
+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).
 
-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).
+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)
+.
 
 ### GitHub code scanning
 
-You can set up [GitHub code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) for your project using Qodana. To do it, add these lines to the `code_quality.yml` workflow file right 
-below the [basic configuration](#how-to-start-github-action) of Qodana Scan:
+You can set
+up [GitHub code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)
+for your project using Qodana. To do it, add these lines to the `code_quality.yml` workflow file right below
+the [basic configuration](#how-to-start-github-action) of Qodana Scan:
 
 ```yaml
       - uses: github/codeql-action/upload-sarif@v1
         with:
           sarif_file: ${{ runner.temp }}/qodana/results/qodana.sarif.json
 ```
-This sample invokes `codeql-action` for uploading a SARIF-formatted Qodana report to GitHub, and specifies the report file
-using the `sarif_file` key.
 
-> 💡 GitHub code scanning does not export inspection results to third-party tools, which means that you cannot use this data 
-for further processing by Qodana. In this case, you have to set up baseline and quality gate processing on the Qodana 
-side prior to submitting inspection results to GitHub code scanning, see the
-<a href="qodana-github-action.md" anchor="github-actions-quality-gate-baseline">Quality gate and baseline</a> section 
-for details. 
+This sample invokes `codeql-action` for uploading a SARIF-formatted Qodana report to GitHub, and specifies the report
+file using the `sarif_file` key.
+
+> 💡 GitHub code scanning does not export inspection results to third-party tools, which means that you cannot use this data for further processing by Qodana. In this case, you have to set up baseline and quality gate processing on the Qodana side prior to submitting inspection results to GitHub code scanning, see the
+<a href="qodana-github-action.md" anchor="github-actions-quality-gate-baseline">Quality gate and baseline</a> section for details.
 
 ### Pull request quality gate
 
 You can enforce GitHub to block the merge of pull requests if the Qodana quality gate has failed. To do it, create a
-[branch protection rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) as described below:
+[branch protection rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
+as described below:
 
 1. Create a new or open an existing GitHub workflow that invokes the Qodana Scan action.
 2. Set the workflow to run on `pull_request` events that target the `main` branch.
+
 ```yaml
 on:
   pull_request:
     branches:
-    - main
+      - main
 ```
 
 Instead of `main`, you can specify your branch here.
@@ -99,9 +106,8 @@ Instead of `main`, you can specify your branch here.
 
 ### Quality gate and baseline
 
-
-You can combine the [quality gate](quality-gate.xml) and [baseline](qodana-baseline.xml) features to manage 
-your technical debt, report only new problems, and block pull requests that contain too many problems. 
+You can combine the [quality gate](quality-gate.xml) and [baseline](qodana-baseline.xml) features to manage your
+technical debt, report only new problems, and block pull requests that contain too many problems.
 
 Follow these steps to establish a baseline for your project:
 
@@ -112,31 +118,31 @@ docker run --rm -v <source-directory>/:/data/project/ \
   -p 8080:8080 jetbrains/qodana-<linter> --show-report
 ```
 
-2. Open your report at `http://localhost:8080/`, [add detected problems](ui-overview.md#Technical+debt) to the baseline, 
-and download the `qodana.sarif.json` file.
+2. Open your report at `http://localhost:8080/`, [add detected problems](ui-overview.md#Technical+debt) to the baseline,
+   and download the `qodana.sarif.json` file.
 
-3. Upload the `qodana.sarif.json` file to your project root folder on GitHub. 
+3. Upload the `qodana.sarif.json` file to your project root folder on GitHub.
 
 4. Append this line to the Qodana Scan action configuration in the `code_quality.yml` file:
 
 ```yaml
 baseline-path: qodana.sarif.json; 
 ```
 
-If you want to update the baseline, you need to repeat these steps once again. 
+If you want to update the baseline, you need to repeat these steps once again.
 
 Starting from this, GitHub will generate alters only for the problems that were not added to the baseline as new.
 
-To establish a quality gate additionally to the baseline, add this line to `code_quality.yml` right after the 
+To establish a quality gate additionally to the baseline, add this line to `code_quality.yml` right after the
 `baseline-path` line:
 
 ```yaml
 fail-threshold: <number-of-accepted-problems>
 ```
 
-Based on this, you will be able to detect only new problems in pull requests that fall beyond the baseline.
-At the same time, pull requests with **new** problems exceeding the `fail-threshold` limit will be blocked and the 
-workflow will fail.
+Based on this, you will be able to detect only new problems in pull requests that fall beyond the baseline. At the same
+time, pull requests with **new** problems exceeding the `fail-threshold` limit will be blocked and the workflow will
+fail.
 
 ### GitHub Pages
 
@@ -151,23 +157,23 @@ can host them on your [GitHub Pages](https://docs.github.com/en/pages) repositor
           publish_dir: ${{ runner.temp }}/qodana/results/report
           destination_dir: ./
 ```
+
 <note>Hosting of multiple Qodana reports in a single GitHub Pages repository is not supported.</note>
 
 ### Get a Qodana badge
 
-You can set up a Qodana workflow badge in your repository: 
+You can set up a Qodana workflow badge in your repository:
 
-[![Qodana](https://github.com/JetBrains/qodana-action/actions/workflows/code_scanning.yml/badge.svg)](https://github.com/JetBrains/qodana-action/actions/workflows/code_scanning.yml) 
+[![Qodana](https://github.com/JetBrains/qodana-action/actions/workflows/code_scanning.yml/badge.svg)](https://github.com/JetBrains/qodana-action/actions/workflows/code_scanning.yml)
 
 To do it, follow these steps:
 
 1. Navigate to the workflow run that you previously configured.
-2. On the workflow page, select **Create status badge**.  
+2. On the workflow page, select **Create status badge**.
 3. Copy the Markdown text to your repository README file.
 
 <img src="https://user-images.githubusercontent.com/13538286/148529278-5d585f1d-adc4-4b22-9a20-769901566924.png" alt="Creating status badge" width="706"/>
 
-
 ## Configuration
 
 | Name                       | Description                                                                                                                        | Default Value                           |
@@ -188,15 +194,14 @@ To do it, follow these steps:
 | `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 }}`                   |
 
-
-
 ## Issue Tracker
 
 All the issues, feature requests, and support related to the Qodana GitHub Action are handled on [YouTrack][youtrack].
@@ -215,18 +220,29 @@ This repository contains source code for Qodana GitHub Action and is licensed un
 
 View [license information](https://www.jetbrains.com/legal/?fromFooter#licensing) for the Qodana Community images.
 
-Qodana Docker images may contain other software which is subject to other licenses, for example, Bash relating to the base distribution or with any direct or indirect dependencies of the primary software.
+Qodana Docker images may contain other software which is subject to other licenses, for example, Bash relating to the
+base distribution or with any direct or indirect dependencies of the primary software.
 
-As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
+As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies
+with any relevant licenses for all software contained within.
 
 #### Qodana EAP images
 
-Using the Qodana EAP Docker images, you agree to [JetBrains EAP user agreement](https://www.jetbrains.com/legal/docs/toolbox/user_eap/) and [JetBrains privacy policy](https://www.jetbrains.com/legal/docs/privacy/privacy/). The docker image includes an evaluation license which will expire in 30-day. Please ensure you pull a new image on time.
+Using the Qodana EAP Docker images, you agree
+to [JetBrains EAP user agreement](https://www.jetbrains.com/legal/docs/toolbox/user_eap/)
+and [JetBrains privacy policy](https://www.jetbrains.com/legal/docs/privacy/privacy/). The docker image includes an
+evaluation license which will expire in 30-day. Please ensure you pull a new image on time.
 
 [gh:qodana]: https://github.com/JetBrains/qodana-action/actions/workflows/code_scanning.yml
+
 [youtrack]: https://youtrack.jetbrains.com/issues/QD
+
 [youtrack-new-issue]: https://youtrack.jetbrains.com/newIssue?project=QD&c=Platform%20GitHub%20Action
+
 [jb:confluence-on-gh]: https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub
+
 [jb:discussions]: https://jb.gg/qodana-discussions
+
 [jb:twitter]: https://twitter.com/Qodana
+
 [jb:docker]: https://hub.docker.com/r/jetbrains/qodana
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -76,7 +76,8 @@ function inputsDefaultFixture(): Inputs {
     artifactName: 'Qodana report',
     useCaches: true,
     useAnnotations: true,
-    githubToken: ''
+    githubToken: '',
+    token: ''
   }
 }
 

diff --git a/action.yaml b/action.yaml
@@ -57,6 +57,9 @@ inputs:
   script:
     description: 'Override the default docker scenario'
     required: false
+  token:
+    description: 'Qodana Cloud token'
+    required: false
   profile-name:
     description: 'Name of a profile defined in the project'
     required: false

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map