Experiment

.ci/scripts/validate_commit_message.py

@@ -9,21 +9,17 @@
 import sys
 from pathlib import Path
 import subprocess
-
-
 import os
 import warnings
 from github import Github
 
-
 NO_ISSUE = "[noissue]"
 CHANGELOG_EXTS = [".feature", ".bugfix", ".doc", ".removal", ".misc", ".deprecation"]
+KEYWORDS = ["fixes", "closes"]
+
 sha = sys.argv[1]
 message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")
 
-
-KEYWORDS = ["fixes", "closes"]
-
 g = Github(os.environ.get("GITHUB_TOKEN"))
 repo = g.get_repo("pulp/pulp_gem")
 

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-364-g6f9579c
+2021.08.26-376-gba57590

.github/workflows/ci.yml

@@ -46,6 +46,9 @@ jobs:
         run: |
           python .ci/scripts/check_requirements.py
 
+  docs:
+    uses: "./.github/workflows/docs.yml"
+
   lint:
     uses: "./.github/workflows/lint.yml"
 
@@ -84,6 +87,7 @@ jobs:
       - "check-commits"
       - "lint"
       - "test"
+      - "docs"
     if: "always()"
     steps:
       - name: "Collect needed jobs results"

.github/workflows/create-branch.yml

@@ -26,14 +26,20 @@ jobs:
           fetch-depth: 0
           path: "pulp_gem"
 
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 1
+          repository: "pulp/plugin_template"
+          path: "plugin_template"
+
       - uses: "actions/setup-python@v5"
         with:
           python-version: "3.11"
 
       - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
-          pip install bump2version jinja2 pyyaml packaging
+          pip install bump2version jinja2 pyyaml packaging -r plugin_template/requirements.txt
           echo ::endgroup::
 
       - name: "Setting secrets"
@@ -71,13 +77,6 @@ jobs:
         run: |
           find CHANGES -type f -regex ".*\.\(bugfix\|doc\|feature\|misc\|deprecation\|removal\)" -exec git rm {} +
 
-      - name: Checkout plugin template
-        uses: actions/checkout@v4
-        with:
-          repository: pulp/plugin_template
-          path: plugin_template
-          fetch-depth: 0
-
       - name: Update CI branches in template_config
         working-directory: plugin_template
         run: |

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+# WARNING: DO NOT EDIT!
+#
+# This file was generated by plugin_template, and is managed by it. Please use
+# './plugin-template --github pulp_gem' to update this file.
+#
+# For more info visit https://github.com/pulp/plugin_template
+
+---
+name: "Docs"
+on:
+  workflow_call:
+
+jobs:
+  test:
+    if: "endsWith(github.base_ref, 'main')"
+    runs-on: "ubuntu-20.04"
+    defaults:
+      run:
+        working-directory: "pulp_gem"
+    steps:
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 1
+          path: "pulp_gem"
+      - uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.11"
+      - name: "Setup cache key"
+        run: |
+          git ls-remote https://github.com/pulp/pulp-docs main | tee pulp-docs-main-sha
+      - uses: "actions/cache@v4"
+        with:
+          path: "~/.cache/pip"
+          key: ${{ runner.os }}-pip-${{ hashFiles('pulp-docs-main-sha') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: "Install python dependencies"
+        run: |
+          echo ::group::PYDEPS
+          pip install -r doc_requirements.txt
+          echo ::endgroup::
+      - name: "Build changelog"
+        run: |
+          towncrier build --yes --version 4.0.0.ci
+      - name: "Build docs"
+        run: |
+          pulp-docs build
+
+  no-test:
+    if: "!endsWith(github.base_ref, 'main')"
+    runs-on: "ubuntu-20.04"
+    steps:
+      - run: |
+          echo "Skip docs testing on non-main branches."

.github/workflows/scripts/install.sh

@@ -21,18 +21,13 @@ PLUGIN_SOURCE="./pulp_gem/dist/pulp_gem-${PLUGIN_VERSION}-py3-none-any.whl"
 export PULP_API_ROOT="/pulp/"
 
 PIP_REQUIREMENTS=("pulp-cli-gem")
-if [[ "$TEST" = "docs" || "$TEST" = "publish" ]]
-then
-  PIP_REQUIREMENTS+=("-r" "doc_requirements.txt")
-fi
 
+# This must be the **only** call to "pip install" on the test runner.
 pip install ${PIP_REQUIREMENTS[*]}
 
-if [[ "$TEST" != "docs" ]]
-then
-  PULP_CLI_VERSION="$(pip freeze | sed -n -e 's/pulp-cli-gem==//p')"
-  git clone --depth 1 --branch "$PULP_CLI_VERSION" https://github.com/pulp/pulp-cli-gem.git ../pulp-cli-gem
-fi
+# Check out the pulp-cli-gem branch matching the installed version.
+PULP_CLI_VERSION="$(pip freeze | sed -n -e 's/pulp-cli-gem==//p')"
+git clone --depth 1 --branch "$PULP_CLI_VERSION" https://github.com/pulp/pulp-cli-gem.git ../pulp-cli-gem
 
 cd .ci/ansible/
 if [ "$TEST" = "s3" ]; then
@@ -126,9 +121,7 @@ if [ "${PULP_API_ROOT:-}" ]; then
 fi
 
 pulp config create --base-url https://pulp --api-root "$PULP_API_ROOT" --username "admin" --password "password"
-if [[ "$TEST" != "docs" ]]; then
-  cp ~/.config/pulp/cli.toml "${REPO_ROOT}/../pulp-cli-gem/tests/cli.toml"
-fi
+cp ~/.config/pulp/cli.toml "${REPO_ROOT}/../pulp-cli-gem/tests/cli.toml"
 
 ansible-playbook build_container.yaml
 ansible-playbook start_container.yaml

.github/workflows/scripts/script.sh

@@ -18,22 +18,14 @@ source .github/workflows/scripts/utils.sh
 export POST_SCRIPT=$PWD/.github/workflows/scripts/post_script.sh
 export FUNC_TEST_SCRIPT=$PWD/.github/workflows/scripts/func_test_script.sh
 
-# Needed for both starting the service and building the docs.
+# Needed for starting the service
 # Gets set in .github/settings.yml, but doesn't seem to inherited by
 # this script.
 export DJANGO_SETTINGS_MODULE=pulpcore.app.settings
 export PULP_SETTINGS=$PWD/.ci/ansible/settings/settings.py
 
 export PULP_URL="https://pulp"
 
-if [[ "$TEST" = "docs" ]]; then
-  if [[ "$GITHUB_WORKFLOW" == "Gem CI" ]]; then
-    towncrier build --yes --version 4.0.0.ci
-  fi
-  pulp-docs build
-  exit
-fi
-
 REPORTED_STATUS="$(pulp status)"
 
 echo "machine pulp

.github/workflows/test.yml

@@ -22,7 +22,6 @@ jobs:
       matrix:
         env:
           - TEST: pulp
-          - TEST: docs
           - TEST: azure
           - TEST: s3
           - TEST: lowerbounds

doc_requirements.txt

@@ -1,10 +1,8 @@
 # WARNING: DO NOT EDIT!
 #
 # This file was generated by plugin_template, and is managed by it. Please use
-# './plugin-template --docs pulp_gem' to update this file.
+# './plugin-template --github pulp_gem' to update this file.
 #
 # For more info visit https://github.com/pulp/plugin_template
--r requirements.txt
 towncrier
-
 pulp-docs @ git+https://github.com/pulp/pulp-docs@main