Skip to content

Commit

Permalink
doc: Link to troubleshooting page on failed checksum calculation
Browse files Browse the repository at this point in the history
  • Loading branch information
Paulo Ribeiro committed Sep 2, 2021
1 parent 1ad8fee commit 98b771f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/troubleshooting-common-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ description: Instructions or workarounds to overcome common issues while using C

The sections below provide instructions or workarounds to overcome common issues while using Codacy Coverage Reporter.

## sha512sum: command not found while checking checksum {: id="checksum"}
## Can't validate checksum {: id="checksum"}

Starting on version [13.0.0](https://github.com/codacy/codacy-coverage-reporter/releases/tag/13.0.0) the `get.sh` script automatically validates the checksum of the downloaded Codacy Coverage Reporter binary. This requires having the `sha512sum` command on the operating system where you're running the script.
Starting on version [13.0.0](https://github.com/codacy/codacy-coverage-reporter/releases/tag/13.0.0) the `get.sh` script automatically validates the checksum of the downloaded Codacy Coverage Reporter binary. This requires having either the `sha512sum` or `shasum` command on the operating system where you're running the script.

If you're getting this error while uploading your coverage data to Codacy, install the correct version of `sha512sum` for the operating system that you're using.
If you're getting this error while uploading your coverage data to Codacy, install the correct version of `sha512sum` or `shasum` for the operating system that you're using.

You can also skip validating the checksum of the binary by defining the following environment variable, however, Codacy doesn't recommend this:

Expand Down
2 changes: 1 addition & 1 deletion get.sh
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ checksum() {
elif command -v shasum > /dev/null 2>&1; then
sha_check_command="shasum -a 512"
else
fatal "Error: no method of validating checksum, please install 'sha512sum' or 'shasum'. You can skip this check by setting CODACY_REPORTER_SKIP_CHECKSUM=true"
fatal "Error: can't validate checksum, please see https://docs.codacy.com/coverage-reporter/troubleshooting-common-issues/#checksum"
fi

log "$i" "Expected checksum"
Expand Down

0 comments on commit 98b771f

Please sign in to comment.