Skip to content

Commit

Permalink
docs: add explanation of args
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Dec 17, 2024
1 parent 9ca1616 commit 807f58e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,12 @@ Otherwise, a new comment is created.
`--comment-tag` (optional, string) A unique identifier for comments posted. Used
to find and update/overwrite existing comments.

These options provide flexibility in how you manage comments. For example, you can continually update or overwrite a single comment or create separate comments per workflow or job.

For example, the following command creates or updates a comment tagged with the current workflow and job names:

`npx github-actions-ctrf pull-request path-to-your-ctrf-report.json --update-comment --comment-tag "${{ github.workflow }}-${{ github.job }}"`

## Previous Test Results

### Filtering
Expand Down

0 comments on commit 807f58e

Please sign in to comment.