Skip to content

Commit

Permalink
Comment out doc build until ghostwriter registgered with LTD
Browse files Browse the repository at this point in the history
  • Loading branch information
athornton committed Sep 7, 2024
1 parent 8ab50bc commit 9e3b491
Showing 1 changed file with 46 additions and 45 deletions.
91 changes: 46 additions & 45 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,51 +54,52 @@ jobs:
tox-envs: "py,coverage-report,typing"
tox-requirements: requirements/tox.txt

docs:
runs-on: ubuntu-latest
timeout-minutes: 15

steps:
- uses: actions/checkout@v4
with:
# Ensure the documentation gets the right version.
fetch-depth: 0

- uses: lsst-sqre/run-tox@v1
with:
python-version: "3.12"
tox-envs: docs
tox-requirements: "requirements/tox.txt"
cache-key-prefix: docs

# Only attempt documentation uploads for long-lived branches, tagged
# releases, and pull requests from ticket branches. This avoids version
# clutter in the docs and failures when a PR doesn't have access to
# secrets.
- uses: lsst-sqre/ltd-upload@v1
with:
project: ghostwriter
dir: "docs/_build/html"
username: ${{ secrets.LTD_USERNAME }}
password: ${{ secrets.LTD_PASSWORD }}
if: >
github.event_name != 'merge_group'
&& (github.event_name != 'pull_request'
|| startsWith(github.head_ref, 'tickets/'))
linkcheck:
runs-on: ubuntu-latest
timeout-minutes: 15

steps:
- uses: actions/checkout@v4

- name: Check links
uses: lsst-sqre/run-tox@v1
with:
python-version: "3.12"
tox-envs: docs-linkcheck
tox-requirements: "requirements/tox.txt"
# Leave commented out until we enable ghostwriter on LTD
# docs:
# runs-on: ubuntu-latest
# timeout-minutes: 15

# steps:
# - uses: actions/checkout@v4
# with:
# # Ensure the documentation gets the right version.
# fetch-depth: 0

# - uses: lsst-sqre/run-tox@v1
# with:
# python-version: "3.12"
# tox-envs: docs
# tox-requirements: "requirements/tox.txt"
# cache-key-prefix: docs

# # Only attempt documentation uploads for long-lived branches, tagged
# # releases, and pull requests from ticket branches. This avoids version
# # clutter in the docs and failures when a PR doesn't have access to
# # secrets.
# - uses: lsst-sqre/ltd-upload@v1
# with:
# project: ghostwriter
# dir: "docs/_build/html"
# username: ${{ secrets.LTD_USERNAME }}
# password: ${{ secrets.LTD_PASSWORD }}
# if: >
# github.event_name != 'merge_group'
# && (github.event_name != 'pull_request'
# || startsWith(github.head_ref, 'tickets/'))

# linkcheck:
# runs-on: ubuntu-latest
# timeout-minutes: 15

# steps:
# - uses: actions/checkout@v4

# - name: Check links
# uses: lsst-sqre/run-tox@v1
# with:
# python-version: "3.12"
# tox-envs: docs-linkcheck
# tox-requirements: "requirements/tox.txt"

build:
runs-on: ubuntu-latest
Expand Down

0 comments on commit 9e3b491

Please sign in to comment.