Skip to content
This repository has been archived by the owner on Jan 16, 2025. It is now read-only.

Commit

Permalink
Merge pull request #1 from stacklok/readme-yml-example
Browse files Browse the repository at this point in the history
Add workflow example
  • Loading branch information
lukehinds authored Apr 2, 2024
2 parents 7255f20 + b7470ca commit 4639680
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,37 @@ Full Language Support (inline with Trusty):
* Rust
* Go

## Usage

To use this action, you can add the following to your workflow:

```yaml
name: TrustyPkg Dependency Check

on:
pull_request:
branches:
- main

jobs:
trusty_pkg_check:
runs-on: ubuntu-latest
name: Check Dependencies with TrustyPkg
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: TrustyPkg Action
uses: stacklok/[email protected]
with:
score_threshold: 5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Inputs
Only one input is required for this action:
Only one input is available for this action:
`score_threshold`: The minimum score required for a dependency to be considered
high quality. Anything below this score will fail the action.

0 comments on commit 4639680

Please sign in to comment.