Add pulp_openapi_generator_ref

plugin-template

@@ -52,6 +52,7 @@ DEFAULT_SETTINGS = {
     "pulp_env_azure": {},
     "pulp_env_gcp": {},
     "pulp_env_s3": {},
+    "pulp_openapi_generator_ref": None,
     "pulp_scheme": "https",
     "pulp_settings_azure": {"domain_enabled": True},
     "pulp_settings_gcp": None,
@@ -114,10 +115,6 @@ DEPRECATED_FILES = {
         "flake8.cfg",
         "CHANGES/.TEMPLATE.rst",
     ],
-    "docs": [
-        "docs/_static/.this_makes_it_so_git_keeps_the__static_folder",
-        "docs/_static/api.json",
-    ],
 }
 
 DOCS_OPTION_DEPRECATION_INFO = """\
@@ -254,10 +251,6 @@ def main():
                         if key not in config:
                             config[key] = value
                             write_new_config = True
-                    # Rename "ci_update_branches" to "supported_release_branches"
-                    if "ci_update_branches" in config:
-                        config["supported_release_branches"] = config.pop("ci_update_branches")
-                        write_new_config = True
                     # remove deprecated options
                     for key in set(config.keys()) - set(DEFAULT_SETTINGS.keys()):
                         config.pop(key)
@@ -266,6 +259,7 @@ def main():
                         config["plugins"] = [
                             {"name": config["plugin_name"], "app_label": config["plugin_app_label"]}
                         ]
+                    # Make up for yaml being crazy with version strings.
                     if not all(
                         (
                             isinstance(version, str)
@@ -276,6 +270,9 @@ def main():
                             str(version) for version in config["supported_release_branches"]
                         ]
                         write_new_config = True
+                    if config["pulp_openapi_generator_ref"] == "PIN THIS":
+                        config["pulp_openapi_generator_ref"] = utils.fetch_latest_pog_tag()
+                        write_new_config = True
                     print(
                         "\nLoaded plugin template config from "
                         "{path}/template_config.yml.\n".format(path=plugin_root_dir)

scripts/update_ci.sh

@@ -15,6 +15,7 @@ then
   sed -i \
     -e 's/^\(ci_update_docs: \)true$/\1false/' \
     -e 's/^\(docs_test: \)true$/\1false/' \
+    -e 's/^\(pulp_openapi_generator_ref: \)null/\1"PIN THIS"/' \
     "template_config.yml"
 fi
 

templates/github/.github/workflows/build.yml.j2

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       {{ checkout(path=plugin_name) | indent(6) }}
-      {{ checkout(repository="pulp/pulp-openapi-generator", path="pulp-openapi-generator") | indent(6) }}
+      {{ checkout(repository="pulp/pulp-openapi-generator", path="pulp-openapi-generator", ref=pulp_openapi_generator_ref) | indent(6) }}
       {{ setup_python() | indent(6) }}
       {{ install_python_deps(["packaging", "twine", "wheel", "mkdocs", "jq"]) | indent(6) }}
       {%- if os_required_packages %}

templates/github/.github/workflows/create-branch.yml.j2

@@ -6,16 +6,13 @@
   install_python_deps
 with context %}
 ---
-name: Create New Release Branch
+name: "Create New Release Branch"
 on:
   workflow_dispatch:
 
-env:
-  RELEASE_WORKFLOW: true
-
 jobs:
   create-branch:
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-latest"
 
     strategy:
       fail-fast: false
@@ -59,27 +56,46 @@ jobs:
         run: |
           find CHANGES -type f -regex ".*\.\(bugfix\|doc\|feature\|misc\|deprecation\|removal\)" -exec git rm {} +
 
-      - name: Update CI branches in template_config
-        working-directory: plugin_template
+      - name: "Update CI branches in template_config"
+        working-directory: "plugin_template"
         run: |
           python3 ./plugin-template {{ plugin_name }} --github --latest-release-branch "${NEW_BRANCH}"
           git add -A
 
-      - name: Make a PR with version bump and without CHANGES/*
-        uses: peter-evans/create-pull-request@v6
+      - name: "Make a PR with version bump and without CHANGES/*"
+        uses: "peter-evans/create-pull-request@v6"
         with:
-          path: {{ plugin_name }}
-          token: {{ '${{ secrets.RELEASE_TOKEN }}' }}
-          committer: {{release_user}} <{{ release_email }}>
-          author: {{release_user}} <{{ release_email }}>
-          branch: minor-version-bump
-          base: {{ plugin_default_branch }}
-          title: Bump minor version
+          path: "{{ plugin_name }}"
+          token: "{{ '${{ secrets.RELEASE_TOKEN }}' }}"
+          committer: "{{release_user}} <{{ release_email }}>"
+          author: "{{release_user}} <{{ release_email }}>"
+          branch: "minor-version-bump"
+          base: "{{ plugin_default_branch }}"
+          title: "Bump minor version"
           commit-message: |
             Bump minor version
           delete-branch: true
 
-      - name: Push release branch
-        working-directory: {{ plugin_name }}
+      - name: "Push release branch"
+        working-directory: "{{ plugin_name }}"
         run: |
           git push origin "${NEW_BRANCH}"
+          git switch "${NEW_BRANCH}"
+          ../plugin_template/scripts/update_ci --release
+
+      - name: "Make a PR with to setup the new release branch"
+        uses: "peter-evans/create-pull-request@v6"
+        with:
+          path: "{{ plugin_name }}"
+          token: "{{ '${{ secrets.RELEASE_TOKEN }}' }}"
+          committer: "{{release_user}} <{{ release_email }}>"
+          author: "{{release_user}} <{{ release_email }}>"
+          branch: "{{ 'update-ci/${{ env.NEW_BRANCH }}' }}"
+          base: "${{ '{{ env.NEW_BRANCH }}' }}"
+          title: "Setup Release branch"
+          body: "[noissue]"
+          commit-message: |
+            Bump minor version
+            [noissue]
+          delete-branch: true
+...

utils.py

@@ -58,3 +58,18 @@ def get_pulpdocs_members() -> list[str]:
         )
 
     return [line.strip()[8:] for line in response.content.decode().split("\n") if "- name:" in line]
+
+
+def fetch_latest_pog_tag():
+    response = requests.get(
+        "https://api.github.com/repos/pulp/pulp-openapi-generator/git/refs/tags"
+    )
+    tags = [item["ref"] for item in response.json()]
+    matched_tags = sorted(
+        [
+            ((int(match.group(1)), int(match.group(2))), f"{match.group(1)}.{match.group(2)}")
+            for match in (re.fullmatch(r"^refs/tags/(\d{8})\.(\d+)$", tag) for tag in tags)
+            if match is not None
+        ]
+    )
+    return matched_tags[-1][1]