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 examples and output samples #28

Merged
merged 2 commits into from
Sep 15, 2024
Merged

Enhance README with usage examples and output samples #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7d1637
Update README.md
guibranco Sep 15, 2024
9bee22e
Merge branch 'main' into guibranco-patch-2
gstraccini[bot] Sep 15, 2024
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
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

🚨 :octocat: A GitHub action to check and report secret leaks in the repository using [Infisical CLI](https://infisical.com/docs/cli/commands/scan).

---

## Usage

None.
Expand All @@ -17,6 +19,8 @@ None.

None.

---

## Example

```yml
Expand All @@ -38,3 +42,14 @@ on:
- name: Run the action
uses: guibranco/github-infisical-secrets-check-action@latest
```
---

## Sample output

### Success - no secrets leaked

[!success](success.png)

### Failure - secrets leaked

[!failure](failure.png)