Skip to content

Commit

Permalink
Fill out the README with details
Browse files Browse the repository at this point in the history
* Add usage example
* Add details of the inputs

Signed-off-by: Eric Brown <ericwb@users.noreply.github.com>
  • Loading branch information
ericwb committed Mar 10, 2024
1 parent 2871902 commit c95c85f
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# precli-action
# Precaution Analysis Action

Analyze your source code using Precaution via [precli](https://github.com/securesauce/precli).

## Usage

Here is a minimal complete example to create a Code Scanning action using Precaution.

```yaml
name: Precaution

on:
workflow_dispatch:

jobs:
analyze:
runs-on: ubuntu-latest
permissions:
# required for all workflows
security-events: write
# only required for workflows in private repositories
actions: read
contents: read
steps:
- name: Perform Precaution Analysis
uses: securesauce/precli-action@v1
```
## Inputs
### `path`

**Optional** The source file(s) or directory(s) to be analyzed

**Default** `"."`

### `disable`

**Optional** A comma-separated list of rule IDs or names to disable

**Default** `"DEFAULT"`

0 comments on commit c95c85f

Please sign in to comment.