Skip to content

Commit ed5a1b0

Browse files
authored
docs: describe how to run natspec-smells in CI (#62)
1 parent 15dfae2 commit ed5a1b0

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

Diff for: README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,18 @@ npx @defi-wonderland/natspec-smells --include "src/**/*.sol"
5555

5656
## Verify your natspec in CI
5757

58-
_Soon to come._
58+
With the setup defined above, it's possible to invoke the executable from within a github workflow, as long as node.js is available in that environment:
59+
60+
```
61+
steps:
62+
- uses: actions/checkout@v3
63+
64+
- name: Use Node.js
65+
uses: actions/setup-node@v3
66+
67+
- name: Check natspec
68+
run: yarn natspec-smells
69+
```
5970

6071
## Options
6172

0 commit comments

Comments
 (0)