Skip to content

Commit

Permalink
Create codacy.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
gdha committed May 25, 2023
1 parent 3333cf8 commit 3cb64f1
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/workflows/codacy.yml
@@ -0,0 +1,61 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# This workflow checks out code, performs a Codacy security scan
# and integrates the results with the
# GitHub Advanced Security code scanning feature. For more information on
# the Codacy security scan action usage and parameters, see
# https://github.com/codacy/codacy-analysis-cli-action.
# For more information on Codacy Analysis CLI in general, see
# https://github.com/codacy/codacy-analysis-cli.

name: Codacy Security Scan

on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '24 1 * * 6'

permissions:
contents: read

jobs:
codacy-security-scan:
permissions:
contents: read # for actions/checkout to fetch code
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
name: Codacy Security Scan
runs-on: ubuntu-latest
steps:
# Checkout the repository to the GitHub Actions runner
- name: Checkout code
uses: actions/checkout@v3

# Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
- name: Run Codacy Analysis CLI
uses: codacy/codacy-analysis-cli-action@d840f886c4bd4edc059706d09c6a1586111c540b
with:
# Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
# You can also omit the token and run the tools that support default configurations
project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
verbose: true
output: results.sarif
format: sarif
# Adjust severity of non-security issues
gh-code-scanning-compat: true
# Force 0 exit code to allow SARIF file generation
# This will handover control about PR rejection to the GitHub side
max-allowed-issues: 2147483647

# Upload the SARIF file generated in the previous step
- name: Upload SARIF results file
uses: github/codeql-action/upload-sarif@v2
with:
sarif_file: results.sarif

4 comments on commit 3cb64f1

@pcahyna
Copy link
Member

@pcahyna pcahyna commented on 3cb64f1 Jun 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @gdha , this scan seems to duplicate Differential ShellCheck (at least partially) but with different settings. We report only issues with the error severity in Differential ShellCheck, but Codacy reports other issues. See #2991 (review) .

@jsmeix
Copy link
Member

@jsmeix jsmeix commented on 3cb64f1 Aug 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least for now I disabled the "Codacy Security Scan" workflow as described in
https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow

@pcahyna
Copy link
Member

@pcahyna pcahyna commented on 3cb64f1 Aug 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least for now I disabled the "Codacy Security Scan" workflow as described in https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow

Can you reference your commit or PR please?

@jsmeix
Copy link
Member

@jsmeix jsmeix commented on 3cb64f1 Aug 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pcahyna
there is no commit or PR.
It was "just some clicks" in the GitHub web frontend as described in
https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow

Please sign in to comment.