Skip to content

Commit 85d4e4d

Browse files
authored
docs: add example usage to license_check (#164)
1 parent 171226e commit 85d4e4d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

site/docs/workflows/license_check.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,31 @@ The allowed and forbidden options can't be used at the same time. If you want to
7272
**Optional** Disregard licenses that failed to be retrieved.
7373

7474
**Default** `false`
75+
76+
## Example Usage
77+
78+
```yaml
79+
name: license_check
80+
81+
concurrency:
82+
group: ${{ github.workflow }}-${{ github.ref }}
83+
cancel-in-progress: true
84+
85+
on:
86+
pull_request:
87+
paths:
88+
- 'pubspec.yaml'
89+
- '.github/workflows/license_check.yaml'
90+
push:
91+
branches:
92+
- main
93+
paths:
94+
- 'pubspec.yaml'
95+
- '.github/workflows/license_check.yaml'
96+
97+
jobs:
98+
license_check:
99+
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/license_check.yml@v1
100+
with:
101+
allowed: 'MIT,BSD-3-Clause,BSD-2-Clause,Apache-2.0'
102+
```

0 commit comments

Comments
 (0)