codacy-analysis-cli
codacy-analysis-cli copied to clipboard
[CY-6700] Being able to read config from `.codacy.yaml`
Hi
I'm using this cli inside GitHub actions
but I found out that this content in .codacy.yaml
file is not working for me (That's not removing my problems related to md
files)
exclude_paths:
- "**.md"
I want to exclude any non go
files how to do for that thing?
Internal ticket created : CY-6700
Also here is my GitHub actions file
# 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: '27 12 * * 0'
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@d43127fe38d20c527dc1951ae5aea23148bab738
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
When I run Spotbug with .codacy.yml configuration file in the repository root
01/14 00:54:31 INFO c.c.a.c.a.AnalyseExecutor:206 - Found local extra configuration for spotbugs 01/14 00:54:31 INFO c.c.a.c.a.AnalyseExecutor:188 - Preparing to run spotbugs with remote configuration
Then 0 result is found.
Why was not the local configuration used?
Command used to run Spotbugs tool (from Jenkins)
sudo codacy-analysis-cli analyze --api-token ****** --provider gh --username **** --project **** --tool spotbugs --allow-network --upload --verbose --skip-uncommitted-files-check --commit-uuid **** --directory pwd
Content of .codacy.yml
engines: spotbugs: enabled: true base_sub_dir: /home/user/workspace/project modules: - classesDirectories: [ "module1/build/classes" ] sourceDirectories: [ "module1/source" ]
When I run sudo codacy-analysis-cli validate-configuration
, I got Could not find Codacy configuration file. Make sure you have a file named like one of .codacy.yaml, .codacy.yml.
even when the .codacy.yml file is in the repository root folder. However, when I run sudo codacy-analysis-cli validate-configuration --directory pwd
, it works