diff --git a/README.md b/README.md index 2106ea5..6db6428 100644 --- a/README.md +++ b/README.md @@ -372,16 +372,19 @@ Please refer to earlier parts of the documentation for the configuration of thes The action exposes the following outputs which may be used in a workflow's steps succeeding the analysis. -| Variable | Value | Description | -|--------------------|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| -| `analyze-output` | Auto-generated, or `analyze-output` input | The directory where the **raw** analysis output files (either created by the analysers, or by the converter) are available. | -| `logfile` | Auto-generated, or `logfile` input | The JSON Compilation Database of the analysis that was executed. | -| `diff-html-dir` | Auto-generated. | The directory where the **user-friendly HTML** bug reports were generated to about the **new** findings (if `diff` was enabled). | -| `diff-result-log` | Auto-generated. | `CodeChecker cmd diff`'s output log file which contains the **new** findings dumped into it. | -| `diff-run-name` | Auto-generated, or `diff-run-name` input | The name of the analysis run (if `diff` was enabled) against which the reports were compared. | -| `result-html-dir` | Auto-generated. | The directory where the **user-friendly HTML** bug reports were generated to. | -| `result-log` | Auto-generated. | `CodeChecker parse`'s output log file which contains the findings dumped into it. | -| `store-run-name` | Auto-generated, or `store-run-name` input | The name of the analysis run (if `store` was enabled) to which the results were uploaded to. | -| `store-successful` | `true` or `false` | Whether storing the results succeeded. Useful for optionally breaking the build later to detect networking failures. | -| `warnings` | `true` or `false` | Whether the static analysers reported any findings. | -| `warnings-in-diff` | `true` or `false` | If `diff` was enabled, whether there were **new** findings in the current analysis when compared against the contents of the server. | +| Variable | Value | Description | +|-----------------------|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| `analyze-output` | Auto-generated, or `analyze-output` input | The directory where the **raw** analysis output files (either created by the analysers, or by the converter) are available. | +| `codechecker-version` | Auto-generated (likely same as input `version`) | The version of the installed CodeChecker that performed the analysis. | +| `codechecker-hash` | Auto-generated. | The Git hash of the installed CodeChecker that performed the analysis. | +| `logfile` | Auto-generated, or `logfile` input | The JSON Compilation Database of the analysis that was executed. | +| `llvm-version` | Auto-generated. | The full version string of the installed *LLVM/Clang* package (as reported by `clang --version`). | +| `diff-html-dir` | Auto-generated. | The directory where the **user-friendly HTML** bug reports were generated to about the **new** findings (if `diff` was enabled). | +| `diff-result-log` | Auto-generated. | `CodeChecker cmd diff`'s output log file which contains the **new** findings dumped into it. | +| `diff-run-name` | Auto-generated, or `diff-run-name` input | The name of the analysis run (if `diff` was enabled) against which the reports were compared. | +| `result-html-dir` | Auto-generated. | The directory where the **user-friendly HTML** bug reports were generated to. | +| `result-log` | Auto-generated. | `CodeChecker parse`'s output log file which contains the findings dumped into it. | +| `store-run-name` | Auto-generated, or `store-run-name` input | The name of the analysis run (if `store` was enabled) to which the results were uploaded to. | +| `store-successful` | `true` or `false` | Whether storing the results succeeded. Useful for optionally breaking the build later to detect networking failures. | +| `warnings` | `true` or `false` | Whether the static analysers reported any findings. | +| `warnings-in-diff` | `true` or `false` | If `diff` was enabled, whether there were **new** findings in the current analysis when compared against the contents of the server. | diff --git a/action.yml b/action.yml index 498fc53..1a5f2e6 100644 --- a/action.yml +++ b/action.yml @@ -95,6 +95,16 @@ inputs: default: '__DEFAULT__' outputs: + codechecker-version: + description: 'The version of the installed CodeChecker package.' + value: ${{ steps.codechecker.outputs.VERSION }} + codechecker-hash: + description: 'The Git hash of the installed CodeChecker package.' + value: ${{ steps.codechecker.outputs.GITSEVEN }} + llvm-version: + description: 'The version of the installed LLVM package, if the install was requested.' + value: ${{ steps.llvm.outputs.REAL_VERSION }} + logfile: description: 'The location of the JSON Compilation Database that was used for the analysis.' value: ${{ steps.log.outputs.COMPILATION_DATABASE }} diff --git a/src/pip-codechecker.sh b/src/pip-codechecker.sh index 1723fab..da91e73 100755 --- a/src/pip-codechecker.sh +++ b/src/pip-codechecker.sh @@ -3,7 +3,7 @@ if [[ ! -z "$CODECHECKER_ACTION_DEBUG" ]]; then set -x fi -echo "::group::Installing CodeChecker for PyPI" +echo "::group::Installing CodeChecker from PyPI" if [[ "$IN_VERSION" == "master" ]]; then # The default branch name "master" is offered as a convenient shortcut for # fetching the latest release.