Skip to content

Commit

Permalink
Unrelated doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ewjoachim committed Aug 3, 2023
1 parent 460671c commit 5153bdb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ jobs:
path: python-coverage-comment-action.txt
```
The "Store Pull Request comment to be posted" step as well as the file below
are only needed in contexts where some contributors don't have write access to
the repository. In closed-source context, it's likely that all contributors
have write-access (i.e. nobody uses forks), you can remove both.
```yaml
# .github/workflows/coverage.yml
name: Post coverage comment
Expand Down
9 changes: 6 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ inputs:
default: false
ANNOTATION_TYPE:
description: >
Only needed if ANNOTATE_MISSING_LINES is set to true. This parameter allows you to choose between
Only relevant if ANNOTATE_MISSING_LINES is set to true. This parameter allows you to choose between
notice, warning and error as annotation type. For more information look here:
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-notice-message
default: warning
Expand All @@ -91,8 +91,10 @@ inputs:
outputs:
COMMENT_FILE_WRITTEN:
description: >
If "true", a comment file was written to COMMENT_FILENAME. If "false",
no comment file was written (because the comment was already posted).
Only set when running in PR mode. If "true", a comment file was written
to COMMENT_FILENAME and you'll need to run the action in workflow_run
mode to post it. If "false", no comment file was written (because the
comment was already posted to the PR).
runs:
using: docker
image: Dockerfile
Expand All @@ -104,6 +106,7 @@ runs:
COVERAGE_PATH: ${{ inputs.COVERAGE_PATH }}
COMMENT_ARTIFACT_NAME: ${{ inputs.COMMENT_ARTIFACT_NAME }}
COMMENT_FILENAME: ${{ inputs.COMMENT_FILENAME }}
SUBPROJECT_ID: ${{ inputs.SUBPROJECT_ID }}
MINIMUM_GREEN: ${{ inputs.MINIMUM_GREEN }}
MINIMUM_ORANGE: ${{ inputs.MINIMUM_ORANGE }}
MERGE_COVERAGE_FILES: ${{ inputs.MERGE_COVERAGE_FILES }}
Expand Down

0 comments on commit 5153bdb

Please sign in to comment.