Skip to content

Commit

Permalink
ci: fix docs ci (#401)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
grant committed Dec 2, 2021
1 parent 8aef26e commit 2073558
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Expand Up @@ -15,7 +15,7 @@ jobs:
node-version: '16'
- name: Install dependencies
run: npm install
- name: Build TypeScript project
run: npm run build
- name: Build docs
run: npm run docs
- name: Ensure there are no changes in docs
run: git diff --exit-code docs/
28 changes: 14 additions & 14 deletions docs/generated/api.json
Expand Up @@ -206,7 +206,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface CloudEventFunction "
"text": "export declare interface CloudEventFunction "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -265,7 +265,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface CloudEventFunctionWithCallback "
"text": "export declare interface CloudEventFunctionWithCallback "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -340,7 +340,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface CloudFunctionsContext "
"text": "export declare interface CloudFunctionsContext "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -495,7 +495,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Data "
"text": "export declare interface Data "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -537,7 +537,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EventFunction "
"text": "export declare interface EventFunction "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -611,7 +611,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EventFunctionWithCallback "
"text": "export declare interface EventFunctionWithCallback "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -793,7 +793,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface HttpFunction "
"text": "export declare interface HttpFunction "
}
],
"releaseTag": "Public",
Expand All @@ -810,17 +810,17 @@
},
{
"kind": "Reference",
"text": "Request",
"canonicalReference": "@google-cloud/functions-framework!Request:interface"
"text": "Request_2",
"canonicalReference": "@google-cloud/functions-framework!~Request_2:interface"
},
{
"kind": "Content",
"text": ", res: "
},
{
"kind": "Reference",
"text": "Response",
"canonicalReference": "@google-cloud/functions-framework!Response:type"
"text": "Response_2",
"canonicalReference": "@google-cloud/functions-framework!~Response_2:type"
},
{
"kind": "Content",
Expand Down Expand Up @@ -903,7 +903,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface LegacyEvent "
"text": "export declare interface LegacyEvent "
}
],
"releaseTag": "Public",
Expand Down Expand Up @@ -972,7 +972,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Request extends "
"text": "declare interface Request_2 extends "
},
{
"kind": "Reference",
Expand Down Expand Up @@ -1029,7 +1029,7 @@
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type Response = "
"text": "declare type Response_2 = "
},
{
"kind": "Reference",
Expand Down

0 comments on commit 2073558

Please sign in to comment.