Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brenoepics committed Jun 16, 2024
1 parent f18b551 commit 7d82ea0
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# GitRoll Scanning Action

> [!IMPORTANT]
> The action mode `wait` still in development.
This repository contains a GitHub Action that requests a GitRoll scan for a given GitHub user.

## Action Details
Expand Down Expand Up @@ -29,40 +32,35 @@ For example, you can create a file named
`scan.yml` with the following content:

```yaml

name: Scan

on:
cron:
- '0 0 * * *'
schedule:
- cron: "30 0 * * *"
workflow_dispatch:
push:

jobs:
scan:
runs-on: ubuntu-latest
steps:
- name: GitRoll Scan
uses: brenoepics/gitroll-action@v1
scan:
runs-on: ubuntu-latest
steps:
- name: browser install
run: npx puppeteer browsers install chrome
- name: GitRoll Scan
uses: brenoepics/gitroll-action@v0.1.0
```
This workflow will run every day at midnight and request a scan for the `brenoepics` user.
</details>

<details>
<summary>Using in a workflow</summary>

To use this action in a workflow, you can reference it with the `uses` keyword
and the path to the repository. You can also specify inputs with the `with`
keyword. For example:
This workflow will run every day at midnight and request a scan for the repository owner username,
you can also specify the username with the `username` input.

```yaml
steps:
- name: Example Step
uses: brenoepics/gitroll-action@v1
with:
username: 'brenoepics'
wait: 'true'
- name: GitRoll Scan
uses: brenoepics/gitroll-action@v0.1.0
with:
username: 'brenoepics'
```

This will request a scan for the `brenoepics` user and wait for the scan to complete.
</details>

## License
Expand Down

0 comments on commit 7d82ea0

Please sign in to comment.