Update CI files

.ci/scripts/check_release.py

@@ -1,28 +1,21 @@
 #!/usr/bin/env python
 
-# WARNING: DO NOT EDIT!
-#
-# This file was generated by plugin_template, and is managed by it. Please use
-# './plugin-template --github pulp_certguard' to update this file.
-#
-# For more info visit https://github.com/pulp/plugin_template
-
 import argparse
 import re
 import os
+import tomllib
 import yaml
+from pathlib import Path
 from tempfile import TemporaryDirectory
 from packaging.version import Version
 from git import Repo
 
-UPSTREAM_REMOTE = "https://github.com/pulp/pulp-certguard.git"
-DEFAULT_BRANCH = "main"
 RELEASE_BRANCH_REGEX = r"^([0-9]+)\.([0-9]+)$"
 Y_CHANGELOG_EXTS = [".feature", ".removal", ".deprecation"]
 Z_CHANGELOG_EXTS = [".bugfix", ".doc", ".misc"]
 
 
-def main():
+def options():
     """Check which branches need a release."""
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -32,17 +25,60 @@ def main():
         "'supported'. Defaults to 'supported', see `supported_release_branches` in "
         "`plugin_template.yml`.",
     )
-    opts = parser.parse_args()
+    return parser.parse_args()
+
+
+def template_config():
+    # Assume this script lies in .ci/scripts
+    path = Path(__file__).absolute().parent.parent.parent / "template_config.yml"
+    return yaml.safe_load(path.read_text())
+
 
+def current_version(repo, commitish):
+    try:
+        pyproject_toml = tomllib.loads(repo.git.show(f"{commitish}:pyproject.toml"))
+        try:
+            current_version = pyproject_toml["project"]["version"]
+        except Exception:
+            current_version = pyproject_toml["tool"]["bumpversion"]["current_version"]
+    except Exception:
+        current_version = repo.git.grep(
+            "current_version", commitish, "--", ".bumpversion.cfg"
+        ).split("=")[-1]
+    return Version(current_version)
+
+
+def check_pyproject_dependencies(repo, from_commit, to_commit):
+    try:
+        old_pyproject = tomllib.load(repo.show("{from_commit}:pyproject.toml"))
+        old_dependencies = set(old_pyproject["project"]["dependencies"])
+        new_pyproject = tomllib.load(repo.show("{to_commit}:pyproject.toml"))
+        new_dependencies = set(new_pyproject["project"]["dependencies"])
+        if old_dependencies != new_dependencies:
+            return ["dependencies"]
+        else:
+            return []
+    except Exception as e:
+        print(f"WARNING: Comparing the dependencies in pyproject.toml failed. ({e})")
+        # Gathering more details failed.
+        return ["pyproject.toml changed somehow (PLEASE check if dependencies are affected)."]
+
+
+def main(options, template_config):
     with TemporaryDirectory() as d:
         # Clone from upstream to ensure we have updated branches & main
+        GITHUB_ORG = template_config["github_org"]
+        PLUGIN_NAME = template_config["plugin_name"]
+        UPSTREAM_REMOTE = f"https://github.com/{GITHUB_ORG}/{PLUGIN_NAME}.git"
+        DEFAULT_BRANCH = template_config["plugin_default_branch"]
+
         repo = Repo.clone_from(UPSTREAM_REMOTE, d, filter="blob:none")
         heads = [h.split("/")[-1] for h in repo.git.ls_remote("--heads").split("\n")]
         available_branches = [h for h in heads if re.search(RELEASE_BRANCH_REGEX, h)]
         available_branches.sort(key=lambda ver: Version(ver))
         available_branches.append(DEFAULT_BRANCH)
 
-        branches = opts.branches
+        branches = options.branches
         if branches == "supported":
             with open(f"{d}/template_config.yml", mode="r") as f:
                 tc = yaml.safe_load(f)
@@ -90,9 +126,7 @@ def main():
                     f"{last_tag}", f"origin/{branch}", "--name-only", "--", "pyproject.toml"
                 )
                 if pyproject_diff:
-                    reasons.append(
-                        "pyproject.toml changed (PLEASE check if dependencies are affected."
-                    )
+                    reasons.extend(check_pyproject_dependencies(repo, last_tag, f"origin/{branch}"))
 
                 if reasons:
                     curr_version = Version(last_tag)
@@ -113,15 +147,10 @@ def main():
                 for change in changes.split("\n"):
                     _, ext = os.path.splitext(change)
                     if ext in Y_CHANGELOG_EXTS:
-                        # We don't put Y release bumps in the commit message, check file instead
-                        # The 'current_version' is always the next version to release
-                        next_version = repo.git.grep(
-                            "current_version", DEFAULT_BRANCH, "--", ".bumpversion.cfg"
-                        ).split("=")[-1]
-                        next_version = Version(next_version)
-                        print(
-                            f"A new Y-release is needed! New Version: {next_version.base_version}"
-                        )
+                        # We don't put Y release bumps in the commit message, check file instead.
+                        # The 'current_version' is always the dev of the next version to release.
+                        next_version = current_version(repo, DEFAULT_BRANCH).base_version
+                        print(f"A new Y-release is needed! New Version: {next_version}")
                         releases.append(next_version)
                         break
 
@@ -130,4 +159,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main(options(), template_config())

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-394-gd21e6ea
+2021.08.26-405-g3845bbc

.github/workflows/ci.yml

@@ -53,6 +53,9 @@ jobs:
   test:
     needs: "build"
     uses: "./.github/workflows/test.yml"
+    with:
+      matrix_env: |
+        [{"TEST": "pulp"}, {"TEST": "azure"}, {"TEST": "s3"}, {"TEST": "lowerbounds"}]
 
   deprecations:
     runs-on: "ubuntu-latest"

.github/workflows/nightly.yml

@@ -29,6 +29,9 @@ jobs:
   test:
     needs: "build"
     uses: "./.github/workflows/test.yml"
+    with:
+      matrix_env: |
+        [{"TEST": "pulp"}, {"TEST": "azure"}, {"TEST": "s3"}, {"TEST": "lowerbounds"}]
 
   changelog:
     runs-on: ubuntu-latest
@@ -65,3 +68,4 @@ jobs:
           branch: "changelog/update"
           delete-branch: true
           path: "pulp-certguard"
+...

.github/workflows/scripts/install.sh

@@ -15,7 +15,7 @@ set -euv
 
 source .github/workflows/scripts/utils.sh
 
-PLUGIN_VERSION="$(sed -n -e 's/^\s*current_version\s*=\s*//p' .bumpversion.cfg | python -c 'from packaging.version import Version; print(Version(input()))')"
+PLUGIN_VERSION="$(bump-my-version show current_version | tail -n -1 | python -c 'from packaging.version import Version; print(Version(input()))')"
 PLUGIN_SOURCE="./pulp-certguard/dist/pulp_certguard-${PLUGIN_VERSION}-py3-none-any.whl"
 
 export PULP_API_ROOT="/pulp/"

.github/workflows/scripts/publish_plugin_pypi.sh

@@ -28,6 +28,6 @@ then
 fi
 
 twine upload -u __token__ -p "$PYPI_API_TOKEN" \
-"dist/pulp_certguard-$VERSION-py3-none-any.whl" \
-"dist/pulp-certguard-$VERSION.tar.gz" \
+dist/pulp?certguard-"$VERSION"-py3-none-any.whl \
+dist/pulp?certguard-"$VERSION".tar.gz \
 ;

.github/workflows/test.yml

@@ -9,6 +9,10 @@
 name: "Test"
 on:
   workflow_call:
+    inputs:
+      matrix_env:
+        required: true
+        type: string
 
 defaults:
   run:
@@ -20,11 +24,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        env:
-          - TEST: pulp
-          - TEST: azure
-          - TEST: s3
-          - TEST: lowerbounds
+        env: ${{ fromJSON(inputs.matrix_env) }}
 
     steps:
       - uses: "actions/checkout@v4"
@@ -71,7 +71,7 @@ jobs:
       - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
-          pip install towncrier twine wheel httpie docker netaddr boto3 'ansible~=10.3.0' mkdocs jq jsonpatch
+          pip install towncrier twine wheel httpie docker netaddr boto3 'ansible~=10.3.0' mkdocs jq jsonpatch bump-my-version
           echo "HTTPIE_CONFIG_DIR=$GITHUB_WORKSPACE/pulp-certguard/.ci/assets/httpie/" >> $GITHUB_ENV
           echo ::endgroup::
 
@@ -88,10 +88,6 @@ jobs:
           ANSIBLE_FORCE_COLOR: "1"
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           GITHUB_CONTEXT: "${{ github.event.pull_request.commits_url }}"
-      - uses: ruby/setup-ruby@v1
-        if: ${{ env.TEST == 'pulp' }}
-        with:
-          ruby-version: "2.6"
 
       - name: "Install"
         run: |

pyproject.toml

@@ -50,3 +50,34 @@ exclude = '''
   | docs
 )/
 '''
+
+[tool.bumpversion]
+# This section is managed by the plugin template. Do not edit manually.
+
+current_version = "1.7.3.dev"
+commit = false
+tag = false
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\.(?P<release>[a-z]+))?"
+serialize = [
+	"{major}.{minor}.{patch}.{release}",
+	"{major}.{minor}.{patch}",
+]
+
+[tool.bumpversion.parts.release]
+# This section is managed by the plugin template. Do not edit manually.
+
+optional_value = "prod"
+values = [
+	"dev",
+	"prod",
+]
+
+[[tool.bumpversion.files]]
+# This section is managed by the plugin template. Do not edit manually.
+
+filename = "./pulp_certguard/app/__init__.py"
+search = "version = \"{current_version}\""
+replace = "version = \"{new_version}\""
+
+[[tool.bumpversion.files]]
+filename = "./setup.py"