Skip to content

Commit 58f7afd

Browse files
committed
Update README.md
1 parent eff4fa4 commit 58f7afd

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

lint/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ A composite GitHub Action that runs [prek](https://github.com/j178/prek) (a fast
77
- `action.yml` - Composite action with all logic
88
- `workflow.yml.tmpl` - Workflow template for syncing to repos
99

10+
## Syncing to Repositories
11+
12+
To adopt this workflow via template-files, add to your `.github/template-files/config.yml`:
13+
14+
```yaml
15+
- source: lint/workflow.yml.tmpl
16+
target: .github/workflows/lint.yml
17+
# Optional: additional branch patterns (main is always included)
18+
# branches:
19+
# - '2[0-9].[0-9]+.x' # CalVer release branches
20+
# Optional: Python version for prek hooks
21+
# python_version: '3.12'
22+
```
23+
1024
## Features
1125

1226
- Installs and runs prek with your existing `.pre-commit-config.yaml`

0 commit comments

Comments
 (0)