Skip to content

Commit

Permalink
Some more tweaking of input and variable naming
Browse files Browse the repository at this point in the history
  • Loading branch information
fgrosse committed Mar 18, 2024
1 parent 852c8af commit fd8a2d4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ inputs:
default: "v1.0.0"

sha256sum:
description: 'Expected SHA256 checksum of the tarball when downloading the go-coverage-report binary.'
description: 'Optional SHA256 checksum of the tarball when downloading the go-coverage-report binary.'
required: false

coverage-artifact-name:
Expand All @@ -128,7 +128,7 @@ inputs:
required: true
default: "coverage.txt"

repo-import-path:
root-package:
description: |
The Go import path of the tested repository to add as a prefix to all paths of the
changed files. This is useful to map the changed files (e.g., ["foo/my_file.go"]
Expand Down
8 changes: 4 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ branding:

inputs:
version:
description: 'The exact version of the go-coverage-report tool to use.'
description: 'The exact version tag of the go-coverage-report tool to use.'
required: true
default: "v1.0.0"

sha256sum:
description: 'Expected SHA256 checksum of the tarball when downloading the go-coverage-report binary.'
description: 'Optional SHA256 checksum of the tarball when downloading the go-coverage-report binary.'
required: false

coverage-artifact-name:
Expand All @@ -25,7 +25,7 @@ inputs:
required: true
default: "coverage.txt"

repo-import-path:
root-package:
description: |
The Go import path of the tested repository to add as a prefix to all paths of the
changed files. This is useful to map the changed files (e.g., ["foo/my_file.go"]
Expand Down Expand Up @@ -74,5 +74,5 @@ runs:
CHANGED_FILES_PATH: .github/outputs/all_changed_files.json
COVERAGE_ARTIFACT_NAME: ${{ inputs.coverage-artifact-name }}
COVERAGE_FILE_NAME: ${{ inputs.coverage-file-name }}
REPOSITORY_IMPORT_PATH: ${{ inputs.repo-import-path }}
ROOT_PACKAGE: ${{ inputs.root-package }}
TRIM_PACKAGE: ${{ inputs.trim }}
4 changes: 2 additions & 2 deletions scripts/github-action.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can use the following environment variables to configure the script:
- COVERAGE_ARTIFACT_NAME: The name of the artifact containing the code coverage results (default: code-coverage)
- COVERAGE_FILE_NAME: The name of the file containing the code coverage results (default: coverage.txt)
- CHANGED_FILES_PATH: The path to the file containing the list of changed files (default: .github/outputs/all_changed_files.json)
- REPOSITORY_IMPORT_PATH: The import path of the tested repository to add as a prefix to all paths of the changed files (optional)
- ROOT_PACKAGE: The import path of the tested repository to add as a prefix to all paths of the changed files (optional)
- TRIM_PACKAGE: Trim a prefix in the \"Impacted Packages\" column of the markdown report (optional)
"

Expand Down Expand Up @@ -96,7 +96,7 @@ end_group

start_group "Compare code coverage results"
go-coverage-report \
-root="$REPOSITORY_IMPORT_PATH" \
-root="$ROOT_PACKAGE" \
-trim="$TRIM_PACKAGE" \
"$OLD_COVERAGE_PATH" \
"$NEW_COVERAGE_PATH" \
Expand Down

0 comments on commit fd8a2d4

Please sign in to comment.