From ce06a7d67bdcf8f5c05bbfd998db287db97209a2 Mon Sep 17 00:00:00 2001 From: Thomas Cederholm Date: Tue, 5 Nov 2024 09:07:09 +0100 Subject: [PATCH 1/2] fix: Add code quality action --- code-quality/README.md | 32 ++++++++++++++++++++++++++++++++ code-quality/action.yml | 30 ++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 code-quality/README.md create mode 100644 code-quality/action.yml diff --git a/code-quality/README.md b/code-quality/README.md new file mode 100644 index 000000000..7a0a0be0f --- /dev/null +++ b/code-quality/README.md @@ -0,0 +1,32 @@ +# Code Quality + +GitHub Action to run code quality analysis in your pipeline. + +### Usage + +Using the flag `[skip quality]` in you commit message will disable this action. + +The action will also not run if dependabot is the committer. + +Minimal configuration: +```yaml +steps: + - uses: ... + + - uses: extenda/actions/code-quality@v0 + with: + token: ${{ secrets.QODANA_TOKEN }} + coverage-dir: './path/coverage' +``` + +Full configuration: +```yaml +steps: + - uses: ... + + - uses: extenda/actions/code-quality@v0 + with: + token: ${{ secrets.QODANA_TOKEN }} + coverage-dir: './path/coverage' + baseline: 'qodana.sarif.json' +``` diff --git a/code-quality/action.yml b/code-quality/action.yml new file mode 100644 index 000000000..2a6eb0cf0 --- /dev/null +++ b/code-quality/action.yml @@ -0,0 +1,30 @@ +# action.yml +name: 'Code Quality' +description: 'Trigger Qodana scan' +inputs: + coverage-dir: + description: 'The coverage information path' + required: true + baseline: + description: | + A baseline file path. It contains the current level of coverage and is + treated as a starting point from where to collect new coverage information. + required: false + default: 'qodana.sarif.json' + token: + description: 'The authorization token' + required: true +runs: + using: composite + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Scan with Qodana + uses: JetBrains/qodana-action@v2024.2 + if: github.actor != 'dependabot[bot]' && !contains(github.event.head_commit.message, '[skip quality]') + with: + args: --coverage-dir,${{ inputs.coverage-dir }},--baseline,${{ inputs.baseline }} + env: + QODANA_TOKEN: ${{ inputs.token }} From 88bf42c09ae469591e888e97e348b8c3817463c0 Mon Sep 17 00:00:00 2001 From: Thomas Cederholm Date: Tue, 5 Nov 2024 09:15:58 +0100 Subject: [PATCH 2/2] fix: Rename action --- {code-quality => quality-gate}/README.md | 8 ++++---- {code-quality => quality-gate}/action.yml | 8 ++------ 2 files changed, 6 insertions(+), 10 deletions(-) rename {code-quality => quality-gate}/README.md (75%) rename {code-quality => quality-gate}/action.yml (86%) diff --git a/code-quality/README.md b/quality-gate/README.md similarity index 75% rename from code-quality/README.md rename to quality-gate/README.md index 7a0a0be0f..7991ab070 100644 --- a/code-quality/README.md +++ b/quality-gate/README.md @@ -1,6 +1,6 @@ -# Code Quality +# Quality Gate -GitHub Action to run code quality analysis in your pipeline. +GitHub Action to run quality gate analysis in your pipeline. ### Usage @@ -13,7 +13,7 @@ Minimal configuration: steps: - uses: ... - - uses: extenda/actions/code-quality@v0 + - uses: extenda/actions/quality-gate@v0 with: token: ${{ secrets.QODANA_TOKEN }} coverage-dir: './path/coverage' @@ -24,7 +24,7 @@ Full configuration: steps: - uses: ... - - uses: extenda/actions/code-quality@v0 + - uses: extenda/actions/quality-gate@v0 with: token: ${{ secrets.QODANA_TOKEN }} coverage-dir: './path/coverage' diff --git a/code-quality/action.yml b/quality-gate/action.yml similarity index 86% rename from code-quality/action.yml rename to quality-gate/action.yml index 2a6eb0cf0..46a49d9bd 100644 --- a/code-quality/action.yml +++ b/quality-gate/action.yml @@ -1,6 +1,6 @@ # action.yml -name: 'Code Quality' -description: 'Trigger Qodana scan' +name: 'Quality Gate' +description: 'Assert code quality' inputs: coverage-dir: description: 'The coverage information path' @@ -17,10 +17,6 @@ inputs: runs: using: composite steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Scan with Qodana uses: JetBrains/qodana-action@v2024.2 if: github.actor != 'dependabot[bot]' && !contains(github.event.head_commit.message, '[skip quality]')