Skip to content

Commit

Permalink
Add docgen all script and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed May 22, 2024
1 parent 3883133 commit dcfd3c3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/check-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

name: Doc Change Check (Run "yarn docgen devsite" if this fails)
name: Doc Change Check (Run "yarn docgen:all" if this fails)

on: pull_request

Expand All @@ -33,10 +33,12 @@ jobs:
node-version: 20.x
- name: Yarn install
run: yarn
- name: Run doc generation (devsite docs)
run: yarn docgen devsite
- name: Run doc generation
run: yarn docgen:all
- name: Check for changes in docs-devsite dir (fail if so)
run: git diff --exit-code docs-devsite
- name: Check for changes in toc dir (fail if so)
run: git diff --exit-code toc
- name: Reference documentation needs to be updated. See message below.
if: ${{ failure() }}
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen devsite\` locally to regenerate docs and add them to this PR."
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all\` locally to regenerate docs and add them to this PR."
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,10 @@ root directory to generate the documentation locally:
```
yarn
yarn docgen devsite
yarn docgen:all
```
This will generate reference docs in `docs-devsite/`. Commit and push the generated
This will generate reference docs in `docs-devsite/` and `/toc`. Commit and push the generated
documentation changes to GitHub following the [PR submission guidelines](#submit). Your push
to the remote repository should force any failing documentation checks to execute again.
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"test:saucelabs": "node scripts/run_saucelabs.js",
"docgen": "ts-node-script scripts/docgen/docgen.ts",
"docgen:compat": "node scripts/docgen-compat/generate-docs.js --api js",
"docgen:all": "yarn docgen devsite && yarn docgen toc",
"lint": "lerna run --scope @firebase/* lint",
"lint:fix": "lerna run --scope @firebase/* lint:fix",
"size-report": "ts-node-script scripts/size_report/report_binary_size.ts",
Expand Down

0 comments on commit dcfd3c3

Please sign in to comment.