Skip to content

Commit

Permalink
build: add configuration for automated doc deployment (#722)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe committed May 24, 2019
1 parent 7742bb0 commit e241719
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .kokoro/release/docs.cfg
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"
}
50 changes: 50 additions & 0 deletions .kokoro/release/docs.sh
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 json@9.0.6 -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

0 comments on commit e241719

Please sign in to comment.