File tree 3 files changed +9
-6
lines changed
3 files changed +9
-6
lines changed Original file line number Diff line number Diff line change 12
12
# See the License for the specific language governing permissions and
13
13
# limitations under the License.
14
14
15
- name : Doc Change Check (Run "yarn docgen devsite " if this fails)
15
+ name : Doc Change Check (Run "yarn docgen:all " if this fails)
16
16
17
17
on : pull_request
18
18
@@ -33,10 +33,12 @@ jobs:
33
33
node-version : 20.x
34
34
- name : Yarn install
35
35
run : yarn
36
- - name : Run doc generation (devsite docs)
37
- run : yarn docgen devsite
36
+ - name : Run doc generation
37
+ run : yarn docgen:all
38
38
- name : Check for changes in docs-devsite dir (fail if so)
39
39
run : git diff --exit-code docs-devsite
40
+ - name : Check for changes in toc dir (fail if so)
41
+ run : git diff --exit-code toc
40
42
- name : Reference documentation needs to be updated. See message below.
41
43
if : ${{ failure() }}
42
- run : echo "Changes in this PR affect the reference docs. Run \`yarn docgen devsite \` locally to regenerate docs and add them to this PR."
44
+ run : echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all \` locally to regenerate docs and add them to this PR."
Original file line number Diff line number Diff line change @@ -228,10 +228,10 @@ root directory to generate the documentation locally:
228
228
229
229
```
230
230
yarn
231
- yarn docgen devsite
231
+ yarn docgen: all
232
232
```
233
233
234
- This will generate reference docs in `docs-devsite/`. Commit and push the generated
234
+ This will generate reference docs in `docs-devsite/` and `/toc` . Commit and push the generated
235
235
documentation changes to GitHub following the [PR submission guidelines](#submit). Your push
236
236
to the remote repository should force any failing documentation checks to execute again.
237
237
Original file line number Diff line number Diff line change 40
40
"test:saucelabs" : " node scripts/run_saucelabs.js" ,
41
41
"docgen" : " ts-node-script scripts/docgen/docgen.ts" ,
42
42
"docgen:compat" : " node scripts/docgen-compat/generate-docs.js --api js" ,
43
+ "docgen:all" : " yarn docgen devsite && yarn docgen toc" ,
43
44
"lint" : " lerna run --scope @firebase/* lint" ,
44
45
"lint:fix" : " lerna run --scope @firebase/* lint:fix" ,
45
46
"size-report" : " ts-node-script scripts/size_report/report_binary_size.ts" ,
You can’t perform that action at this time.
0 commit comments