Skip to content

Commit 0629d26

Browse files
authored
Add GitHub action to autogenerate ref docs on commit to master. (#1647)
* Add GitHub action to autogenerate ref docs on commut to master. * Temporarily run doc gen workflow on PRs. * Actually allow action to run on PRs. * Update version of actions/cache to use undepreacted version. * Update versions of all actions. * Revert unintended changes to integration tests. * Only run docgen flow on master commits.
1 parent 0479103 commit 0629d26

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

Diff for: .github/workflows/docs.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Docgen
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-node@v4
14+
with:
15+
node-version: "20"
16+
- name: Cache npm
17+
uses: actions/cache@v4
18+
with:
19+
path: ~/.npm
20+
key: ${{ runner.os }}-docgen-${{ hashFiles('**/package-lock.json') }}
21+
- name: Install dependencies
22+
run: npm ci
23+
- name: Generate Reference Docs
24+
run: |
25+
npm run docgen:v1
26+
npm run docgen:v2
27+
- uses: actions/upload-artifact@v4
28+
name: Upload Docs Preview
29+
with:
30+
name: reference-docs
31+
path: |
32+
./docgen/v1/markdown/
33+
./docgen/v2/markdown/

0 commit comments

Comments
 (0)