Skip to content

Commit fa7bb03

Browse files
committed
actions
1 parent 4f748dc commit fa7bb03

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

docs/tools/coding/git.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,5 +284,28 @@ git push origin v1.3.1
284284

285285
GitHub Actions are very useful workflows to be included or recalled from your repositories, with the purpose of automating checks, deployments, guardrails, tests.
286286

287-
FAST-Computing's workflows are currently stored in https://github.com/FAST-Computing/.github, from which they can be directly recalled in your applications.
287+
FAST-Computing's workflows are currently stored in https://github.com/FAST-Computing/.github, from which they can be directly recalled in your applications:
288+
- Create your own `.github/workflows` directory in the root folder of your project.
289+
- Inside, create a `.yml` file referencing to the original template.
288290

291+
Example:
292+
293+
::: code-group
294+
295+
```sh [pr_code-guardrail.yml]
296+
name: PR Code Guardrail Check
297+
298+
on:
299+
pull_request:
300+
types: [opened, synchronize, reopened]
301+
302+
jobs:
303+
# Note: this can have any name that you prefer
304+
call-code-guardrail:
305+
# Original template
306+
uses: FAST-Computing/.github/.github/workflows/pr_code-guardrail-template.yml@main
307+
with:
308+
# Args
309+
max-lines: 6000
310+
```
311+
:::

0 commit comments

Comments
 (0)