Cleanup

plugin-template

@@ -2,6 +2,7 @@
 # /// script
 # requires-python = ">=3.11"
 # dependencies = [
+#     "black==24.3.0",
 #     "jamldump>=1.2.0,<1.3.0",
 #     "jinja2>=3.1.6,<3.2.0",
 #     "pyyaml>=6.0.3,<6.1.0",
@@ -225,6 +226,11 @@ def main() -> int:
         action="store_true",
         help="Generate or update functional and unit tests.",
     )
+    parser.add_argument(
+        "--ci",
+        action="store_true",
+        help="Generate or update generic CI/CD files.",
+    )
     parser.add_argument(
         "--github",
         action="store_true",
@@ -288,7 +294,7 @@ def main() -> int:
 
     sections = [
         section
-        for section in ["generate_config", "bootstrap", "github", "test"]
+        for section in ["generate_config", "bootstrap", "ci", "github", "test"]
         if getattr(args, section) or args.all or (section == "generate_config" and write_new_config)
     ]
     for section in sections:

scripts/update_ci.sh

@@ -40,20 +40,6 @@ else
   echo "No updates needed"
 fi
 
-if [[ "${USE_BLACK}" == "True" ]]
-then
-  pip install -r lint_requirements.txt
-  black .
-
-  if [[ "$(git status --porcelain)" ]]
-  then
-    git add -A
-    git commit -m "Reformat with black"
-  else
-    echo "No formatting change needed"
-  fi
-fi
-
 # Check that pulpcore lowerbounds is set to a supported branch
 if [[ "${PLUGIN_NAME}" != "pulpcore" ]]; then
   python ../plugin_template/scripts/update_core_lowerbound.py

templates/bootstrap/MANIFEST.in

@@ -4,6 +4,7 @@ exclude CONTRIBUTING.md
 include COPYRIGHT
 include functest_requirements.txt
 include LICENSE
+exclude Makefile
 include pyproject.toml
 include requirements.txt
 include unittest_requirements.txt

templates/ci/Makefile.j2

@@ -0,0 +1,32 @@
+{% include "header.j2" %}
+
+.PHONY: format
+format:
+	{%- if black %}
+	black .
+	{%- else %}
+	@echo "No formating configured in this repository."
+	{%- endif %}
+
+.PHONY: lint
+lint:
+	yamllint -s -d '{extends: relaxed, rules: {line-length: disable}}' .github/workflows
+	bump-my-version bump --dry-run release
+	{%- if black %}
+	black --check --diff .
+	{%- endif %}
+	{%- if flake8 %}
+	flake8
+	{%- endif %}
+	{%- if check_manifest %}
+	check-manifest
+	{%- endif %}
+	{%- if lint_requirements %}
+	python .ci/scripts/check_requirements.py
+	{%- endif %}
+	{%- if check_stray_pulpcore_imports %}
+	sh .ci/scripts/check_pulpcore_imports.sh
+	{%- endif %}
+	{%- if check_gettext %}
+	sh .ci/scripts/check_gettext.sh
+	{%- endif %}

templates/github/.ci/scripts/check_release.py

@@ -11,7 +11,9 @@
 import argparse
 import re
 import os
+import sys
 import tomllib
+import typing as t
 from pathlib import Path
 
 import yaml
@@ -23,7 +25,7 @@
 Z_CHANGELOG_EXTS = [".bugfix", ".misc"]
 
 
-def options():
+def options() -> argparse.Namespace:
     """Check which branches need a release."""
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -42,13 +44,13 @@ def options():
     return parser.parse_args()
 
 
-def template_config():
+def template_config() -> dict[str, t.Any]:
     # 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):
+def current_version(repo: Repo, commitish: str) -> Version:
     try:
         pyproject_toml = tomllib.loads(repo.git.show(f"{commitish}:pyproject.toml"))
         try:
@@ -62,7 +64,7 @@ def current_version(repo, commitish):
     return Version(current_version)
 
 
-def check_pyproject_dependencies(repo, from_commit, to_commit):
+def check_pyproject_dependencies(repo: Repo, from_commit:str, to_commit:str) -> list[str]:
     try:
         new_pyproject = tomllib.loads(repo.git.show(f"{to_commit}:pyproject.toml"))
         try:
@@ -83,8 +85,8 @@ def check_pyproject_dependencies(repo, from_commit, to_commit):
         return ["pyproject.toml changed somehow (PLEASE check if dependencies are affected)."]
 
 
-def main(options, template_config):
-    DEFAULT_BRANCH = template_config["plugin_default_branch"]
+def main(options: argparse.Namespace, template_config: dict[str, t.Any]) -> int:
+    DEFAULT_BRANCH: str = template_config["plugin_default_branch"]
 
     repo = Repo()
 
@@ -97,7 +99,7 @@ def main(options, template_config):
 
     # Warning: This will not work if branch names contain "/" but we don't really care here.
     heads = [h.split("/")[-1] for h in repo.git.branch("--remote").split("\n")]
-    available_branches = [h for h in heads if re.search(RELEASE_BRANCH_REGEX, h)]
+    available_branches = [h for h in heads if re.fullmatch(RELEASE_BRANCH_REGEX, h)]
     available_branches.sort(key=lambda ver: Version(ver))
     available_branches.append(DEFAULT_BRANCH)
 
@@ -114,7 +116,10 @@ def main(options, template_config):
 
     if diff := branches - set(available_branches):
         print(f"Supplied branches contains non-existent branches! {diff}")
-        exit(1)
+        return 1
+
+    branches = [branch for branch in available_branches if branch in branches]
+    branches.reverse()
 
     print(f"Checking for releases on branches: {branches}")
 
@@ -179,6 +184,8 @@ def main(options, template_config):
     if len(releases) == 0:
         print("No new releases to perform.")
 
+    return 0
+
 
 if __name__ == "__main__":
-    main(options(), template_config())
+    sys.exit(main(options(), template_config()))

templates/github/.ci/scripts/collect_changes.py.j2

@@ -1,4 +1,12 @@
 #!/bin/env python3
+# /// script
+# requires-python = ">=3.13"
+# dependencies = [
+#     "gitpython>=3.1.46,<3.2.0",
+#     "packaging>=26.0,<26.1",
+# ]
+# ///
+
 {% include "header.j2" %}
 
 import itertools

templates/github/.github/workflows/nightly.yml.j2

@@ -53,11 +53,20 @@ jobs:
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
+        id: "create_pr_changelog"
         with:
           token: {{ '${{ secrets.RELEASE_TOKEN }}' }}
           title: "Update Changelog"
           body: ""
           branch: "changelog/update"
           delete-branch: true
           path: "{{ plugin_name }}"
+      - name: "Mark PR automerge"
+        working-directory: "{{ plugin_name }}"
+        run: |
+          gh pr merge --rebase --auto "{{ '${{ steps.create_pr_changelog.outputs.pull-request-number }}' }}"
+        if: "steps.create_pr_changelog.outputs.pull-request-number"
+        env:
+          GH_TOKEN: "{{ '${{ secrets.RELEASE_TOKEN }}' }}"
+        continue-on-error: true
 ...