Skip to content

Add CODACY_REPORTER_OPTIONS to get.sh and document it #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Add CODACY_REPORTER_OPTIONS to get.sh and document it #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,20 @@ Usage: codacy-coverage-reporter report
--coverage-reports | -r <your project coverage file name (supports globs)>
--partial <if the report is partial>
--prefix <the project path prefix>
--skip-ssl-verification` [default: false] - Skip the SSL certificate verification when communicating with the Codacy API
--skip-ssl-verification [default: false] - Skip the SSL certificate verification when communicating with the Codacy API
--force-coverage-parser <your coverage parser>
Available parsers are: opencover,clover,lcov,phpunit,jacoco,dotcover,cobertura,go


--> Succeeded!
```

Codacy Coverage Reporter can be run with the `CODACY_REPORTER_OPTIONS` environment variable. This is useful for passing options to the reporter without having to modify the script.

```
CODACY_REPORTER_OPTIONS="--skip-ssl-verification true"
```

## What is Codacy?

[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
Expand Down
13 changes: 11 additions & 2 deletions get.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,13 +231,22 @@ if [ -z "$run_command" ]
then
fatal "Codacy coverage reporter binary could not be found."
fi
if [ -z "$CODACY_REPORTER_OPTIONS" ] || [ -n "$CODACY_REPORTER_OPTIONS" ]; then
EXTRA_ARGUMENTS="$CODACY_REPORTER_OPTIONS"
else
EXTRA_ARGUMENTS=""
fi


if [ "$#" -eq 1 ] && [ "$1" = "download" ];
then
log "$g" "Codacy reporter download succeeded";
elif [ "$#" -gt 0 ];
then
eval "$run_command $*"
log "Running command: $run_command $* $EXTRA_ARGUMENTS"
eval "$run_command $* $EXTRA_ARGUMENTS"
else
eval "$run_command \"report\""
log "Running command: $run_command \"report\" $EXTRA_ARGUMENTS"
eval "$run_command \"report\" $EXTRA_ARGUMENTS"
fi