google-cloud-python/.github/workflows/docs.yml at main · googleapis/google-cloud-python · GitHub

View runs

History

75 lines (73 loc) · 2.67 KB

Raw

on:

push:

branches:

- main

pull_request:

branches:

- main

- preview

# Trigger workflow on GitHub merge queue events

# See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#merge_group

merge_group:

types: [checks_requested]

name: docs

permissions:

contents: read

jobs:

docs:

runs-on: ubuntu-latest

steps:

- name: Checkout

uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

# Use a fetch-depth of 2 to avoid error `fatal: origin/main...HEAD: no merge base`

# See https://github.com/googleapis/google-cloud-python/issues/12013

# and https://github.com/actions/checkout#checkout-head.

with:

fetch-depth: 2

persist-credentials: false

- name: Setup Python

uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6

with:

python-version: "3.10"

- name: Install nox

run: |

python -m pip install --upgrade setuptools pip wheel

python -m pip install nox

- name: Run docs

env:

BUILD_TYPE: presubmit

TARGET_BRANCH: ${{ github.base_ref || github.event.merge_group.base_ref || github.ref_name }}

TEST_TYPE: docs

# TODO(https://github.com/googleapis/google-cloud-python/issues/13775): Specify `PY_VERSION` rather than relying on the default python version of the nox session.

PY_VERSION: "unused"

run: |

ci/run_conditional_tests.sh

docfx:

if: github.event_name == 'push' && github.ref == 'refs/heads/main'

runs-on: ubuntu-latest

steps:

- name: Checkout

uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

# Use a fetch-depth of 2 to avoid error `fatal: origin/main...HEAD: no merge base`

# See https://github.com/googleapis/google-cloud-python/issues/12013

# and https://github.com/actions/checkout#checkout-head.

with:

fetch-depth: 2

persist-credentials: false

- name: Setup Python

uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6

with:

python-version: "3.10"

- name: Install nox

run: |

python -m pip install --upgrade setuptools pip wheel

python -m pip install nox

- name: Run docfx

env:

BUILD_TYPE: presubmit

TARGET_BRANCH: ${{ github.base_ref || github.event.merge_group.base_ref || github.ref_name }}

TEST_TYPE: docfx

# TODO(https://github.com/googleapis/google-cloud-python/issues/13775): Specify `PY_VERSION` rather than relying on the default python version of the nox session.

PY_VERSION: "unused"

run: |

ci/run_conditional_tests.sh

google-cloud-python/.github/workflows/docs.yml at main · googleapis/google-cloud-python · GitHub

Uh oh!

Expand file tree

Breadcrumbs

docs.yml

Latest commit

History

Breadcrumbs

docs.yml

File metadata and controls