We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 8d81be3 commit 597f426Copy full SHA for 597f426
docs/getting-started/development-workflow.md
@@ -5,12 +5,19 @@
5
CodeLimit is available as a [GitHub
6
Action](https://github.com/getcodelimit/codelimit-action)
7
8
+Insert CodeLimit in your workflow like this:
9
+
10
+```yaml
11
+- name: 'Run CodeLimit'
12
+ uses: getcodelimit/codelimit-action@v1
13
+```
14
15
When running as a GitHub Action, CodeLimit only checks modified files and
16
*warns* about functions that *should* be refactored and *fails* for functions
17
that *need* to be refactored.
18
-To run CodeLimit on every push and before every merge to `main`, append it to
-your GH Action workflow:
19
+An example of a workflow that runs CodeLimit on every push and before every
20
+merge to `main`:
21
22
```yaml
23
name: 'main'
0 commit comments