Skip to content

Commit

Permalink
docs: describe how to run natspec-smells in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
0xteddybear committed Nov 27, 2024
1 parent 15dfae2 commit 3fffa64
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,18 @@ npx @defi-wonderland/natspec-smells --include "src/**/*.sol"

## Verify your natspec in CI

_Soon to come._
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:

```
steps:
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
- name: Check natspec
run: yarn natspec-smells
```

## Options

Expand Down

0 comments on commit 3fffa64

Please sign in to comment.