This repository has been archived by the owner on Jan 16, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from stacklok/readme-yml-example
Add workflow example
- Loading branch information
Showing
1 changed file
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |