From 055fe1f825b0629b7685d6d3d4d629ffc37a2d7c Mon Sep 17 00:00:00 2001 From: David Galloway Date: Thu, 30 Jun 2022 15:37:58 -0400 Subject: [PATCH] .readthedocs.yml: Always build latest doc/releases pages We don't backport PRs merged into doc/releases. Therefore, when one browses to an older Ceph release version on docs.ceph.com (e.g., https://docs.ceph.com/en/pacific/), the information is out of date at best. The doc/releases page is only accurate if browsing https://docs.ceph.com/en/latest/, for example. So this post_checkout command will make sure we've checked out doc/releases from main before building and publishing. Signed-off-by: David Galloway --- .readthedocs.yml | 12 ++++++++++-- admin/rtd-checkout-main | 6 ++++++ 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100755 admin/rtd-checkout-main diff --git a/.readthedocs.yml b/.readthedocs.yml index ce7de68ae37..361c664fa22 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,15 +1,23 @@ --- # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# +# The pre_build command checks if we're building a named branch (i.e., not a PR). +# If so, check out doc/releases from the main branch before building so +# it's always up to date on docs.ceph.com/en/*. version: 2 formats: [] build: - image: latest + os: ubuntu-22.04 + tools: + python: "3.8" apt_packages: - ditaa + jobs: + pre_build: + - bash admin/rtd-checkout-main python: - version: 3.8 install: - requirements: admin/doc-requirements.txt - requirements: admin/doc-read-the-docs.txt diff --git a/admin/rtd-checkout-main b/admin/rtd-checkout-main new file mode 100755 index 00000000000..931816dce9e --- /dev/null +++ b/admin/rtd-checkout-main @@ -0,0 +1,6 @@ +# See .readthedocs.yml +set -ex +if git symbolic-ref HEAD; then + git checkout origin/main -- doc/releases +fi +git status