Simplify check for reference doc changes (#7014)

.github/CODEOWNERS

@@ -96,6 +96,7 @@ packages/app-check-interop-types @hsubox76 @firebase/jssdk-global-approvers
 # Documentation Changes
 packages/firebase/index.d.ts @egilmorez @firebase/jssdk-global-approvers
 scripts/docgen/content-sources/ @egilmorez @firebase/jssdk-global-approvers
+docs-devsite/ @egilmorez @markarndt
 
 # Changeset
-.changeset @egilmorez @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers
+.changeset @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers

.github/workflows/check-docs.yml

@@ -0,0 +1,28 @@
+name: Doc Change Check (Run "yarn docgen devsite" if this fails)
+
+on: pull_request
+
+jobs:
+  doc-check:
+    name: Check if reference docs have changed
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@master
+      with:
+        # get all history for the diff
+        fetch-depth: 0
+    - name: Set up Node (14)
+      uses: actions/setup-node@v2
+      with:
+        node-version: 14.x
+    - name: Yarn install
+      run: yarn
+    - name: Run doc generation (devsite docs)
+      run: yarn docgen devsite
+    - name: Check for changes in docs-devsite dir (fail if so)
+      run: git diff --exit-code docs-devsite
+    - 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."

docs-devsite/firestore_.aggregatefield.md

@@ -22,7 +22,7 @@ export declare class AggregateField<T>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [type](./firestore_.aggregatefield.md#aggregatefieldtype) |  | string | A type string to uniquely identify instances of this class. |
+|  [type](./firestore_.aggregatefield.md#aggregatefieldtype) |  | (not declared) | A type string to uniquely identify instances of this class. |
 
 ## AggregateField.type
 
@@ -31,5 +31,5 @@ A type string to uniquely identify instances of this class.
 <b>Signature:</b>
 
 ```typescript
-type: string;
+readonly type = "AggregateField";
 ```

docs-devsite/firestore_.aggregatespec.md

@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # AggregateSpec interface
-A type whose property values are all `AggregateField` objects.
+Specifies a set of aggregations and their aliases.
 
 <b>Signature:</b>
 

docs-devsite/firestore_.md

@@ -134,7 +134,7 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Interface | Description |
 |  --- | --- |
-|  [AggregateSpec](./firestore_.aggregatespec.md#aggregatespec_interface) | A type whose property values are all <code>AggregateField</code> objects. |
+|  [AggregateSpec](./firestore_.aggregatespec.md#aggregatespec_interface) | Specifies a set of aggregations and their aliases. |
 |  [DocumentChange](./firestore_.documentchange.md#documentchange_interface) | A <code>DocumentChange</code> represents a change to the documents matching a query. It contains the document affected and the type of change that occurred. |
 |  [DocumentData](./firestore_.documentdata.md#documentdata_interface) | Document data (for use with [setDoc()](./firestore_lite.md#setdoc)<!-- -->) consists of fields mapped to values. |
 |  [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface) | Converter used by <code>withConverter()</code> to transform user objects of type <code>T</code> into Firestore data.<!-- -->Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore. |
@@ -1946,7 +1946,7 @@ The union of all `AggregateField` types that are supported by Firestore.
 <b>Signature:</b>
 
 ```typescript
-export declare type AggregateFieldType = AggregateField<number>;
+export declare type AggregateFieldType = AggregateField<number | null>;
 ```
 
 ## AggregateSpecData

docs-devsite/firestore_lite.aggregatefield.md

@@ -22,7 +22,7 @@ export declare class AggregateField<T>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [type](./firestore_lite.aggregatefield.md#aggregatefieldtype) |  | string | A type string to uniquely identify instances of this class. |
+|  [type](./firestore_lite.aggregatefield.md#aggregatefieldtype) |  | (not declared) | A type string to uniquely identify instances of this class. |
 
 ## AggregateField.type
 
@@ -31,5 +31,5 @@ A type string to uniquely identify instances of this class.
 <b>Signature:</b>
 
 ```typescript
-type: string;
+readonly type = "AggregateField";
 ```

docs-devsite/firestore_lite.aggregatespec.md

@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # AggregateSpec interface
-A type whose property values are all `AggregateField` objects.
+Specifies a set of aggregations and their aliases.
 
 <b>Signature:</b>
 

docs-devsite/firestore_lite.md

@@ -108,7 +108,7 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Interface | Description |
 |  --- | --- |
-|  [AggregateSpec](./firestore_lite.aggregatespec.md#aggregatespec_interface) | A type whose property values are all <code>AggregateField</code> objects. |
+|  [AggregateSpec](./firestore_lite.aggregatespec.md#aggregatespec_interface) | Specifies a set of aggregations and their aliases. |
 |  [DocumentData](./firestore_lite.documentdata.md#documentdata_interface) | Document data (for use with [setDoc()](./firestore_lite.md#setdoc)<!-- -->) consists of fields mapped to values. |
 |  [FirestoreDataConverter](./firestore_lite.firestoredataconverter.md#firestoredataconverter_interface) | Converter used by <code>withConverter()</code> to transform user objects of type <code>T</code> into Firestore data.<!-- -->Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore. |
 |  [Settings](./firestore_lite.settings.md#settings_interface) | Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods. |
@@ -1277,7 +1277,7 @@ The union of all `AggregateField` types that are supported by Firestore.
 <b>Signature:</b>
 
 ```typescript
-export declare type AggregateFieldType = AggregateField<number>;
+export declare type AggregateFieldType = AggregateField<number | null>;
 ```
 
 ## AggregateSpecData

scripts/docgen/docgen.ts

@@ -136,6 +136,11 @@ async function generateDocs(
     `${projectRoot}/packages/auth/api-extractor.json`,
     'utf8'
   );
+  // Save original auth.md as well.
+  const authApiReportOriginal = fs.readFileSync(
+    `${projectRoot}/common/api-review/auth.api.md`,
+    'utf8'
+  );
   const authApiConfigModified = authApiConfigOriginal.replace(
     `"mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.d.ts"`,
     `"mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.doc.d.ts"`
@@ -145,21 +150,39 @@ async function generateDocs(
     authApiConfigModified
   );
 
-  if (!skipBuild) {
-    await spawn('yarn', ['build'], {
-      stdio: 'inherit'
-    });
-
+  if (skipBuild) {
     await spawn('yarn', ['api-report'], {
       stdio: 'inherit'
     });
+  } else {
+    // api-report is run as part of every build
+    await spawn(
+      'yarn',
+      [
+        'lerna',
+        'run',
+        '--scope',
+        '@firebase/*',
+        '--ignore',
+        '@firebase/*-compat',
+        'build'
+      ],
+      {
+        stdio: 'inherit'
+      }
+    );
   }
 
   // Restore original auth api-extractor.json contents.
   fs.writeFileSync(
     `${projectRoot}/packages/auth/api-extractor.json`,
     authApiConfigOriginal
   );
+  // Restore original auth.api.md
+  fs.writeFileSync(
+    `${projectRoot}/common/api-review/auth.api.md`,
+    authApiReportOriginal
+  );
 
   if (!fs.existsSync(tmpDir)) {
     fs.mkdirSync(tmpDir);