From: David Galloway <dgallowa@redhat.com>
Date: Wed, 10 Aug 2022 18:41:35 +0000 (-0400)
Subject: ceph-docs-rtd: Create job to keep releases docs up-to-date
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=631c8d287395d2f70749674552bab192203e09e3;p=ceph-build.git

ceph-docs-rtd: Create job to keep releases docs up-to-date

See ceph/ceph#46917

This Jenkins job will receive webhooks from the github plugin.  It will then check if the main branch is what was updated and if the `doc/releases` dir was updated.

If true, it will trigger a build for each active Ceph release's docs.

ceph/ceph#47442
ceph/ceph#47443
ceph/ceph#47444

Signed-off-by: David Galloway <dgallowa@redhat.com>
---

diff --git a/ceph-doc-releases-rtd/config/definitions/ceph-doc-releases-rtd.yml b/ceph-doc-releases-rtd/config/definitions/ceph-doc-releases-rtd.yml
new file mode 100644
index 00000000..be2350d2
--- /dev/null
+++ b/ceph-doc-releases-rtd/config/definitions/ceph-doc-releases-rtd.yml
@@ -0,0 +1,47 @@
+- job:
+    name: ceph-doc-releases-rtd
+    description: Rebuilds release branch docs so that https://docs.ceph.com/en/$release/releases is always up to date with the main branch. See https://github.com/ceph/ceph/pull/46917.
+    node: small
+    project-type: freestyle
+    defaults: global
+    quiet-period: 5
+    block-downstream: false
+    block-upstream: false
+    properties:
+      - build-discarder:
+          days-to-keep: 1
+          num-to-keep: 10
+          artifact-days-to-keep: -1
+          artifact-num-to-keep: -1
+      - github:
+          url: https://github.com/ceph/ceph
+    discard-old-builds: true
+
+    triggers:
+      - github
+
+    scm:
+      - git:
+          url: https://github.com/ceph/ceph
+          browser: auto
+          branches:
+            - 'origin/main'
+          shallow-clone: true
+          depth: 1
+          skip-tag: true
+          timeout: 20
+          wipe-workspace: true
+          included-regions:
+            - 'doc/releases'
+    builders:
+      - shell: |
+          RELEASES="quincy pacific octopus"
+          for release in $RELEASES; do
+            curl -X POST -H "Authorization: Token $READTHEDOCS_TOKEN" https://readthedocs.org/api/v3/projects/ceph/versions/$release/builds/
+          done
+
+    wrappers:
+      - credentials-binding:
+          - text:
+              credential-id: readthedocs-token
+              variable: READTHEDOCS_TOKEN