Skip to content

docs: Adding docs.yml workflow to update docs on a new tag. #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wangela merged 2 commits into from
Jan 23, 2023
Merged

docs: Adding docs.yml workflow to update docs on a new tag. #360

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e298fd2
docs: Adding docs.yml workflow to update docs on a new tag.
arriolac Apr 24, 2020
2444e85
chore: update actions dependencies
wangela Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Copyright 2023 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.

# A workflow that pushes artifacts to Sonatype
name: Publish

on:
push:
tags:
- '*'
repository_dispatch:
types: [docs]

jobs:
docs:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup Python
uses: "actions/setup-python@v3"
with:
python-version: "3.9"

- name: Install dependencies
run: ./.github/scripts/install.sh

- name: Generate docs
run: python3 -m nox --session docs

- name: Update gh-pages branch with docs
run: |
echo "Creating tar for generated docs"
cd ./docs/_build/html && tar cvf ~/docs.tar .

echo "Unpacking tar into gh-pages branch"
git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
cd $GITHUB_WORKSPACE && git checkout gh-pages && tar xvf ~/docs.tar

- name: PR Changes
uses: peter-evans/create-pull-request@v4
with:
token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }}
commit-message: 'docs: Update docs'
committer: googlemaps-bot <googlemaps-bot@google.com>
author: googlemaps-bot <googlemaps-bot@google.com>
title: 'docs: Update docs'
body: |
Updated GitHub pages with latest from `python3 -m nox --session docs`.
branch: googlemaps-bot/update_gh_pages