Skip to content

Update README.md #12

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

Open
colindembovsky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #12

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
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,20 @@ a future release to provide customization of these templates, via an ability to
## Examples

```
name: Generate Security Report
uses: peter-murray/github-security-report-action@v2
with:
token: ${{ secrets.SECURITY_TOKEN }}
- name: Generate Security Report
uses: peter-murray/github-security-report-action@v2
with:
token: ${{ secrets.SECURITY_TOKEN }}
```

To upload the report as an artifact, use the `actions/upload-artifact` Action:

```
- name: Upload security report
uses: actions/upload-artifact@v2
with:
name: SecuritySummaryReport
path: ${{ github.workspace }}/summary.pdf
```

Example summary report output:
Expand Down