We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 1e30e97 commit 0ba3400Copy full SHA for 0ba3400
README.md
@@ -4,11 +4,14 @@ Action that generates website docs for branches and tags using docgen
4
5
## Usage
6
7
+**Imporant:** this action requires the `docs/docs.json` file to be built **before** the action is run.
8
+
9
How to use it in a workflow:
10
11
```yaml
-- name: Build and deploy documentation
- uses: dbots-pkg/action-docs@v1
12
+- run: npm run docs
13
14
+- uses: dbots-pkg/action-docs@v1
15
env:
16
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17
```
0 commit comments