-
Notifications
You must be signed in to change notification settings - Fork 369
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build: add configuration for automated doc deployment (#722)
- Loading branch information
Showing
2 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# service account used to publish up-to-date docs. | ||
before_action { | ||
fetch_keystore { | ||
keystore_resource { | ||
keystore_config_id: 73713 | ||
keyname: "docuploader_service_account" | ||
} | ||
} | ||
} | ||
|
||
# doc publications use a Python image. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/node:10-user" | ||
} | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "nodejs-storage/.kokoro/trampoline.sh" | ||
|
||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/nodejs-storage/.kokoro/release/docs.sh" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
#!/bin/bash | ||
|
||
# Copyright 2019 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
set -eo pipefail | ||
|
||
# build jsdocs (Python is installed on the Node 10 docker image). | ||
if [[ -z "$CREDENTIALS" ]]; then | ||
# if CREDENTIALS are explicitly set, assume we're testing locally | ||
# and don't set NPM_CONFIG_PREFIX. | ||
export NPM_CONFIG_PREFIX=/home/node/.npm-global | ||
export PATH="$PATH:/home/node/.npm-global/bin" | ||
cd $(dirname $0)/../.. | ||
fi | ||
npm install | ||
npm run docs | ||
|
||
# create docs.metadata, based on package.json and .repo-metadata.json. | ||
npm i [email protected] -g | ||
python3 -m pip install --user gcp-docuploader | ||
python3 -m docuploader create-metadata \ | ||
--name=$(cat .repo-metadata.json | json name) \ | ||
--version=$(cat package.json | json version) \ | ||
--language=$(cat .repo-metadata.json | json language) \ | ||
--distribution-name=$(cat .repo-metadata.json | json distribution_name) \ | ||
--product-page=$(cat .repo-metadata.json | json product_documentation) \ | ||
--github-repository=$(cat .repo-metadata.json | json repo) \ | ||
--issue-tracker=$(cat .repo-metadata.json | json issue_tracker) | ||
cp docs.metadata ./docs/docs.metadata | ||
|
||
# deploy the docs. | ||
if [[ -z "$CREDENTIALS" ]]; then | ||
CREDENTIALS=${KOKORO_KEYSTORE_DIR}/73713_docuploader_service_account | ||
fi | ||
if [[ -z "$BUCKET" ]]; then | ||
BUCKET=docs-staging | ||
fi | ||
python3 -m docuploader upload ./docs --credentials $CREDENTIALS --staging-bucket $BUCKET |