thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(docs): deploy includes website documentation (#7469)

Browse Source 
We now generate the docs into `website/docs` such that it's used by
Docusaurus when we build the site, we need to update the deploy script
to generate those docs first.
This commit is contained in:
Jack Franklin 2021-08-05 11:01:25 +01:00 committed by GitHub
parent 939ac7f94b
commit 6fde41c6b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/deploy-docs.yml vendored
View File

@ -13,6 +13,7 @@ jobs:
- name: Build - name: Build
run: | run: |
npm install npm install
npm run generate-docs
npm run build-docs-production npm run build-docs-production
- name: Set up SSH - name: Set up SSH
uses: webfactory/ssh-agent@v0.4.1 uses: webfactory/ssh-agent@v0.4.1

2
package.json
View File

@ -35,7 +35,7 @@
"tsc-esm": "tsc -b src/tsconfig.esm.json", "tsc-esm": "tsc -b src/tsconfig.esm.json",
"apply-next-version": "node utils/apply_next_version.js", "apply-next-version": "node utils/apply_next_version.js",
"test-install": "scripts/test-install.sh", "test-install": "scripts/test-install.sh",
"clean-docs": "rimraf new-docs && rimraf docs-api-json", "clean-docs": "rimraf website/docs && rimraf docs-api-json",
"generate-d-ts": "npm run clean-docs && api-extractor run --local --verbose", "generate-d-ts": "npm run clean-docs && api-extractor run --local --verbose",
"generate-docs": "npm run generate-d-ts && api-documenter markdown -i docs-api-json -o website/docs && node utils/remove-tag.js", "generate-docs": "npm run generate-d-ts && api-documenter markdown -i docs-api-json -o website/docs && node utils/remove-tag.js",
"ensure-correct-devtools-protocol-revision": "ts-node -s scripts/ensure-correct-devtools-protocol-package", "ensure-correct-devtools-protocol-revision": "ts-node -s scripts/ensure-correct-devtools-protocol-package",