Skip to content

docs: add an explanation to the example usage #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomarra merged 5 commits into from
Jun 3, 2024
Merged

docs: add an explanation to the example usage #199

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a1a233b
docs: add an explanation to the example usage
alestiago Jun 3, 2024
649924e
docs: use job over workflow
alestiago Jun 3, 2024
7f07436
docs: add EOF
alestiago Jun 3, 2024
6f41365
chore: prettier formatter
alestiago Jun 3, 2024
2ee93c2
Merge branch 'main' into alestiago/docs-licence-check-usage-example-s…
tomarra Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions site/docs/workflows/license_check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,11 @@ jobs:
with:
allowed: 'MIT,BSD-3-Clause,BSD-2-Clause,Apache-2.0'
```

The example [workflow file](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow) will [trigger](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow) the `license_check` job on every push to the `main` branch and on every pull request that modifies the `pubspec.yaml` or the `license_check.yaml` workflow file.

If you are [committing the `pubspec.lock`](https://dart.dev/guides/libraries/private-files#pubspec-lock) file for an application package you may consider adding it to the list of paths to trigger the workflow.

:::tip
For repositories with multiple packages we recommend adding a workflow file per package to avoid triggering a license check for packages which dependencies haven't been modified.
:::