Create template sync PRs from versioned branch (#401)

* Adapt TemplateUpdatePR class to distinguish between template and pr branches

* Create versioned branch before making PR

* Fix PR base branch name

* Disable dry-run

Author: grst

.github/workflows/cruft-prs.yml

@@ -22,7 +22,7 @@ jobs:
         with:
           cache-dependency-glob: scripts/pyproject.toml
       - name: Update template repo registry
-        run: uvx --from ./scripts send-cruft-prs ${{ env.RELEASE }} --all_repos --log-dir log --dry-run
+        run: uvx --from ./scripts send-cruft-prs ${{ env.RELEASE }} --all_repos --log-dir log
         env:
           RELEASE: ${{ github.event_name == 'release' && github.event.release.tag_name || github.event.inputs.release }}
           GITHUB_TOKEN: ${{ secrets.BOT_GH_TOKEN }}

scripts/src/scverse_template_scripts/cruft_prs.py

@@ -121,13 +121,20 @@ def title(self) -> str:
         return f"{self.title_prefix}{self.release.tag_name}"
 
     @property
-    def branch(self) -> str:
+    def template_branch(self) -> str:
+        """Branch name in the forked repo that tracks template updates (stay the same across versions)"""
         # as of v0.5.0 (new template sync), the branch name does not contain the release-tag anymore
         return f"{self.branch_prefix}{self.repo_id}"
 
+    @property
+    def pr_branch(self) -> str:
+        """Name of the branch that is used to create the pull-request. A new branch is created for each version."""
+        return f"{self.template_branch}-{self.release.tag_name}"
+
     @property
     def namespaced_head(self) -> str:
-        return f"{self.con.login}:{self.branch}"
+        """Branch used to crate the pull request, including repo namespace"""
+        return f"{self.con.login}:{self.pr_branch}"
 
     @property
     def body(self) -> str:
@@ -141,9 +148,9 @@ def matches_prefix(self, pr: PullRequest) -> bool:
         # Don’t compare title prefix, people might rename PRs
         return pr.head.ref.startswith(self.branch_prefix) and pr.user.id == self.con.user.id
 
-    def matches_exact_branch_name(self, pr: PullRequest) -> bool:
+    def matches_current_version(self, pr: PullRequest) -> bool:
         """Check if `pr` is a template update PR for the current version"""
-        return pr.head.ref == self.branch and pr.user.id == self.con.user.id
+        return pr.head.ref == self.pr_branch and pr.user.id == self.con.user.id
 
 
 class RepoInfo(TypedDict):
@@ -382,6 +389,7 @@ def template_update(  # noqa: PLR0913, (= too many function arguments)
     forked_repo: GHRepo,
     original_repo: GHRepo,
     template_branch_name: str,
+    versioned_branch_name: str,
     tag_name: str,
     cruft_log_file: Path,
     dry_run: bool,
@@ -400,6 +408,8 @@ def template_update(  # noqa: PLR0913, (= too many function arguments)
     4) Use `cruft create` to instantiate the template into a separate directory
     5) sync the changes from the separate directory into the `template-branch`
     6) commit
+    7) check out commit into a version-specific branch used for making the pull request. See #396 for why this is
+       necessary.
 
     --> From this commit, we can make a pull-request to the original repo including the latest template-changes.
 
@@ -411,6 +421,8 @@ def template_update(  # noqa: PLR0913, (= too many function arguments)
         The repo forked in scverse-bot namespace
     template_branch_name
         branch name to use for the template in the forked repo
+    versioned_branch_name
+        version-specific branch name (will be created off the template branch)
     original_repo
         The original (upstream) repo
     tag_name
@@ -446,17 +458,19 @@ def template_update(  # noqa: PLR0913, (= too many function arguments)
             tmp_config = json.load(f)
             exclude_files = tmp_config["context"]["cookiecutter"].get("_exclude_on_template_update", [])
 
-        if _commit_update(
-            clone,
-            exclude_files=exclude_files,
-            commit_msg=f"Automated template update to {tag_name}",
-            commit_author=f"{con.sig.name} <{con.sig.email}>",
-        ):
-            if not dry_run:
-                clone.git.push("origin", template_branch_name)
-            return True
-        else:
-            return False
+        if (
+            updated := _commit_update(
+                clone,
+                exclude_files=exclude_files,
+                commit_msg=f"Automated template update to {tag_name}",
+                commit_author=f"{con.sig.name} <{con.sig.email}>",
+            )
+        ) and not dry_run:
+            clone.git.switch(versioned_branch_name, template_branch_name, C=True)
+            clone.git.push("origin", template_branch_name)
+            clone.git.push("origin", versioned_branch_name)
+
+        return updated
 
 
 def make_pr(con: GitHubConnection, release: GHRelease, repo_url: str, *, log_dir: Path, dry_run: bool = False) -> None:
@@ -490,27 +504,33 @@ def make_pr(con: GitHubConnection, release: GHRelease, repo_url: str, *, log_dir
         con,
         forked_repo=forked_repo,
         original_repo=original_repo,
-        template_branch_name=pr.branch,
+        template_branch_name=pr.template_branch,
+        versioned_branch_name=pr.pr_branch,
         tag_name=release.tag_name,
-        cruft_log_file=log_dir / f"{pr.branch}.log",
+        cruft_log_file=log_dir / f"{pr.template_branch}.log",
         dry_run=dry_run,
     )
     if dry_run:
         log.info("Skipping PR because in dry-run mode")
         return
     if updated:
-        if old_pr := next((p for p in original_repo.get_pulls("open") if pr.matches_exact_branch_name(p)), None):
+        if old_pr := next((p for p in original_repo.get_pulls("open") if pr.matches_current_version(p)), None):
             log.info(f"PR already exists: #{old_pr.number} with branch name `{old_pr.head.ref}`. Skipping PR creation.")
-        else:
-            log.info(f"Creating PR of {pr.namespaced_head} against {original_repo.default_branch}")
-            new_pr = original_repo.create_pull(
-                title=pr.title,
-                body=pr.body,
-                base=original_repo.default_branch,
-                head=pr.namespaced_head,
-                maintainer_can_modify=True,
-            )
-            log.info(f"Created PR #{new_pr.number} with branch name `{new_pr.head.ref}`.")
+            return
+
+        if old_pr := next((p for p in original_repo.get_pulls("open") if pr.matches_prefix(p)), None):
+            log.info(f"Closing old PR #{old_pr.number} with branch name `{old_pr.head.ref}`.")
+            old_pr.edit(state="closed")
+
+        log.info(f"Creating PR of {pr.namespaced_head} against {original_repo.default_branch}")
+        new_pr = original_repo.create_pull(
+            title=pr.title,
+            body=pr.body,
+            base=original_repo.default_branch,
+            head=pr.namespaced_head,
+            maintainer_can_modify=True,
+        )
+        log.info(f"Created PR #{new_pr.number} with branch name `{new_pr.head.ref}`.")
 
 
 cli = App()