Skip to content

Commit 2073558

Browse files
authored
ci: fix docs ci (#401)
It looks like the doc CI check would not produce the right exit code. This should correctly report bad doc errors (see below). - Fixes docs CI error code - Runs docs CI
1 parent 8aef26e commit 2073558

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
node-version: '16'
1616
- name: Install dependencies
1717
run: npm install
18-
- name: Build TypeScript project
19-
run: npm run build
18+
- name: Build docs
19+
run: npm run docs
2020
- name: Ensure there are no changes in docs
2121
run: git diff --exit-code docs/

docs/generated/api.json

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@
206206
"excerptTokens": [
207207
{
208208
"kind": "Content",
209-
"text": "export interface CloudEventFunction "
209+
"text": "export declare interface CloudEventFunction "
210210
}
211211
],
212212
"releaseTag": "Public",
@@ -265,7 +265,7 @@
265265
"excerptTokens": [
266266
{
267267
"kind": "Content",
268-
"text": "export interface CloudEventFunctionWithCallback "
268+
"text": "export declare interface CloudEventFunctionWithCallback "
269269
}
270270
],
271271
"releaseTag": "Public",
@@ -340,7 +340,7 @@
340340
"excerptTokens": [
341341
{
342342
"kind": "Content",
343-
"text": "export interface CloudFunctionsContext "
343+
"text": "export declare interface CloudFunctionsContext "
344344
}
345345
],
346346
"releaseTag": "Public",
@@ -495,7 +495,7 @@
495495
"excerptTokens": [
496496
{
497497
"kind": "Content",
498-
"text": "export interface Data "
498+
"text": "export declare interface Data "
499499
}
500500
],
501501
"releaseTag": "Public",
@@ -537,7 +537,7 @@
537537
"excerptTokens": [
538538
{
539539
"kind": "Content",
540-
"text": "export interface EventFunction "
540+
"text": "export declare interface EventFunction "
541541
}
542542
],
543543
"releaseTag": "Public",
@@ -611,7 +611,7 @@
611611
"excerptTokens": [
612612
{
613613
"kind": "Content",
614-
"text": "export interface EventFunctionWithCallback "
614+
"text": "export declare interface EventFunctionWithCallback "
615615
}
616616
],
617617
"releaseTag": "Public",
@@ -793,7 +793,7 @@
793793
"excerptTokens": [
794794
{
795795
"kind": "Content",
796-
"text": "export interface HttpFunction "
796+
"text": "export declare interface HttpFunction "
797797
}
798798
],
799799
"releaseTag": "Public",
@@ -810,17 +810,17 @@
810810
},
811811
{
812812
"kind": "Reference",
813-
"text": "Request",
814-
"canonicalReference": "@google-cloud/functions-framework!Request:interface"
813+
"text": "Request_2",
814+
"canonicalReference": "@google-cloud/functions-framework!~Request_2:interface"
815815
},
816816
{
817817
"kind": "Content",
818818
"text": ", res: "
819819
},
820820
{
821821
"kind": "Reference",
822-
"text": "Response",
823-
"canonicalReference": "@google-cloud/functions-framework!Response:type"
822+
"text": "Response_2",
823+
"canonicalReference": "@google-cloud/functions-framework!~Response_2:type"
824824
},
825825
{
826826
"kind": "Content",
@@ -903,7 +903,7 @@
903903
"excerptTokens": [
904904
{
905905
"kind": "Content",
906-
"text": "export interface LegacyEvent "
906+
"text": "export declare interface LegacyEvent "
907907
}
908908
],
909909
"releaseTag": "Public",
@@ -972,7 +972,7 @@
972972
"excerptTokens": [
973973
{
974974
"kind": "Content",
975-
"text": "export interface Request extends "
975+
"text": "declare interface Request_2 extends "
976976
},
977977
{
978978
"kind": "Reference",
@@ -1029,7 +1029,7 @@
10291029
"excerptTokens": [
10301030
{
10311031
"kind": "Content",
1032-
"text": "export declare type Response = "
1032+
"text": "declare type Response_2 = "
10331033
},
10341034
{
10351035
"kind": "Reference",

0 commit comments

Comments
 (0)