Skip to content

Commit 597f426

Browse files
committed
docs: 📝 Update
1 parent 8d81be3 commit 597f426

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/getting-started/development-workflow.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,19 @@
55
CodeLimit is available as a [GitHub
66
Action](https://github.com/getcodelimit/codelimit-action)
77

8+
Insert CodeLimit in your workflow like this:
9+
10+
```yaml
11+
- name: 'Run CodeLimit'
12+
uses: getcodelimit/codelimit-action@v1
13+
```
14+
815
When running as a GitHub Action, CodeLimit only checks modified files and
916
*warns* about functions that *should* be refactored and *fails* for functions
1017
that *need* to be refactored.
1118
12-
To run CodeLimit on every push and before every merge to `main`, append it to
13-
your GH Action workflow:
19+
An example of a workflow that runs CodeLimit on every push and before every
20+
merge to `main`:
1421

1522
```yaml
1623
name: 'main'

0 commit comments

Comments
 (0)