forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathupdate_docs.sh
More file actions
executable file
·93 lines (80 loc) · 2.71 KB
/
update_docs.sh
File metadata and controls
executable file
·93 lines (80 loc) · 2.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
#!/bin/bash
# Copyright 2016 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
#
# http://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 -ev
GH_OWNER='GoogleCloudPlatform'
GH_PROJECT_NAME='google-cloud-python'
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
# Function to build the docs.
function build_docs {
rm -rf docs/_build/
rm -f docs/bigquery/generated/*.rst
# -W -> warnings as errors
# -T -> show full traceback on exception
# -N -> no color
sphinx-build \
-W -T -N \
-b html \
-d docs/_build/doctrees \
docs/ \
docs/_build/html/
return $?
}
# Only update docs if we are on CircleCI.
if [[ "${CIRCLE_BRANCH}" == "master" ]] && [[ -z "${CIRCLE_PR_NUMBER}" ]]; then
echo "Building new docs on a merged commit."
elif [[ "$1" == "kokoro" ]]; then
echo "Building and publishing docs on Kokoro."
elif [[ -n "${CIRCLE_TAG}" ]]; then
echo "Building new docs on a tag (but will not deploy)."
build_docs
exit $?
else
echo "Not on master nor a release tag."
echo "Building new docs for testing purposes, but not deploying."
build_docs
exit $?
fi
# Adding GitHub pages branch. `git submodule add` checks it
# out at HEAD.
GH_PAGES_DIR='ghpages'
git submodule add -q -b gh-pages \
"git@github.com:${GH_OWNER}/${GH_PROJECT_NAME}" ${GH_PAGES_DIR}
# Determine if we are building a new tag or are building docs
# for master. Then build new docs in docs/_build from master.
if [[ -n "${CIRCLE_TAG}" ]]; then
# Sphinx will use the package version by default.
build_docs
else
SPHINX_RELEASE=$(git log -1 --pretty=%h) build_docs
fi
# Update gh-pages with the created docs.
cd ${GH_PAGES_DIR}
git rm -fr latest/
cp -R ../docs/_build/html/ latest/
# Update the files push to gh-pages.
git add .
git status
# If there are no changes, just exit cleanly.
if [[ -z "$(git status --porcelain)" ]]; then
echo "Nothing to commit. Exiting without pushing changes."
exit
fi
# Commit to gh-pages branch to apply changes.
git config --global user.email "dpebot@google.com"
git config --global user.name "dpebot"
git commit -m "Update docs after merge to master."
# NOTE: This may fail if two docs updates (on merges to master)
# happen in close proximity.
git push -q origin HEAD:gh-pages