Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance README with usage example and outputs #36

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Enhance README with usage example and outputs #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,18 @@

## Usage

None.
The following example workflow step will scan for secrets leak, add a comment to the pull request and output the quantity of secrets leaked.

```yml

- name: Run the action
uses: guibranco/github-infisical-secrets-check-action@latest
id: secrets-scan
```

## Outputs

None.
- `secrets-leaked`: The number of secrets leaked found by the Infisical CLI tool.

---

Expand Down