Refactor footer production

Author: kdeldycke

repomatic/broken_links.py

@@ -319,13 +319,10 @@ def manage_combined_broken_links_issue(
         sphinx_section = f"## Sphinx linkcheck\n\n{sphinx_content}"
 
     has_broken_links = lychee_has_broken or sphinx_has_broken
-    body = (
-        render_template(
-            "broken-links-issue",
-            lychee_section=lychee_section,
-            sphinx_section=sphinx_section,
-        )
-        + "\n"
+    body = render_template(
+        "broken-links-issue",
+        lychee_section=lychee_section,
+        sphinx_section=sphinx_section,
     )
 
     # Write combined body to a temporary file.

repomatic/github/pr_body.py

@@ -101,8 +101,26 @@ def _substitute(text: str, kwargs: dict[str, str]) -> str:
     return text
 
 
-def render_template(name: str, **kwargs: str) -> str:
-    """Load and render a PR body template with variable substitution.
+def _render_single(name: str, kwargs: dict[str, str]) -> tuple[str, bool]:
+    """Render a single template and return its body with footer preference.
+
+    :param name: Template name without ``.md`` extension.
+    :param kwargs: Variables to substitute into the template.
+    :return: A tuple of (rendered body, wants_footer).
+    """
+    meta, body = load_template(name)
+    result = _substitute(body, kwargs).strip()
+    wants_footer = meta.get("footer") != "false" and name != "generated-footer"
+    return result, wants_footer
+
+
+def render_template(*names: str, **kwargs: str) -> str:
+    """Load and render one or more templates with variable substitution.
+
+    When multiple template names are given, each is rendered and joined with
+    a blank line. The ``generated-footer`` attribution is appended
+    once at the end if **any** of the templates wants it (i.e. does not have
+    ``footer: false`` in its frontmatter).
 
     Static templates (no ``$variable`` placeholders) are returned as-is.
     Dynamic templates use ``string.Template`` (``$variable`` syntax) to avoid
@@ -111,15 +129,24 @@ def render_template(name: str, **kwargs: str) -> str:
     Consecutive blank lines left by empty variables are collapsed to a single
     blank line.
 
-    :param name: Template name without ``.md`` extension.
-    :param kwargs: Variables to substitute into the template.
+    :param names: One or more template names without ``.md`` extension.
+    :param kwargs: Variables to substitute into all templates.
     :return: The rendered markdown string.
     """
-    _meta, body = load_template(name)
-    result = _substitute(body, kwargs)
-    # Collapse runs of 3+ newlines (from empty variable substitutions) into
-    # a single blank line, and strip leading/trailing whitespace.
-    return re.sub(r"\n{3,}", "\n\n", result).strip()
+    parts = []
+    append_footer = False
+    for name in names:
+        body, wants_footer = _render_single(name, kwargs)
+        parts.append(body)
+        if wants_footer:
+            append_footer = True
+    result = "\n\n".join(parts)
+    if append_footer:
+        result += "\n\n" + generated_footer()
+    result = re.sub(r"\n{3,}", "\n\n", result)
+    if append_footer:
+        result += "\n"
+    return result
 
 
 def render_title(name: str, **kwargs: str) -> str:
@@ -243,7 +270,7 @@ def generate_pr_metadata_block() -> str:
         table_format=TableFormat.GITHUB,
     )
 
-    return render_template("generated-footer", table=table)
+    return render_template("pr-metadata", table=table)
 
 
 def _repo_url() -> str:
@@ -274,13 +301,23 @@ def generate_refresh_tip() -> str:
     return render_template("refresh-tip", workflow_dispatch_url=workflow_dispatch_url)
 
 
+def generated_footer() -> str:
+    """Render the attribution footer from the ``generated-footer`` template.
+
+    Single source of truth for the attribution line appended to all PR and
+    issue bodies produced by repomatic.
+
+    :return: A markdown string with a horizontal rule and the attribution line.
+    """
+    return "---\n\n" + render_template("generated-footer")
+
+
 def build_pr_body(prefix: str, metadata_block: str) -> str:
-    """Concatenate prefix, refresh tip, and metadata footer into a PR body.
+    """Concatenate prefix, refresh tip, metadata block, and footer into a PR body.
 
     :param prefix: Content to prepend before the metadata block. Can be empty.
-    :param metadata_block: The generated footer from
-        :func:`generate_pr_metadata_block`, which includes the collapsible
-        metadata table and the attribution line.
+    :param metadata_block: The collapsible metadata block from
+        :func:`generate_pr_metadata_block`.
     :return: The complete PR body string.
     """
     parts: list[str] = []
@@ -290,4 +327,5 @@ def build_pr_body(prefix: str, metadata_block: str) -> str:
     if tip:
         parts.append(tip)
     parts.append(metadata_block)
+    parts.append(generated_footer())
     return "\n\n\n".join(parts)

repomatic/github/unsubscribe.py

@@ -530,16 +530,6 @@ def render_report(result: UnsubscribeResult) -> str:
     p1_detail_table = _render_detail_table(p1.rows)
     details_section = f"---\n\n{p1_detail_table}" if p1_detail_table else ""
 
-    phase1 = render_template(
-        "unsubscribe-phase1",
-        mode=mode,
-        summary_line=summary_line,
-        batch_details_rows=batch_details_rows,
-        state_breakdown_rows=state_breakdown_rows,
-        backlog_warning=backlog_warning,
-        details_section=details_section,
-    )
-
     # Phase 2 content.
     if p2.skipped:
         phase2_content = f"> [!WARNING]\n> {p2.skip_reason}"
@@ -580,14 +570,18 @@ def render_report(result: UnsubscribeResult) -> str:
             p2_parts.extend(["", p2_detail_table])
         phase2_content = "\n".join(p2_parts)
 
-    phase2 = render_template(
+    return render_template(
+        "unsubscribe-phase1",
         "unsubscribe-phase2",
         mode=mode,
+        summary_line=summary_line,
+        batch_details_rows=batch_details_rows,
+        state_breakdown_rows=state_breakdown_rows,
+        backlog_warning=backlog_warning,
+        details_section=details_section,
         phase2_content=phase2_content,
     )
 
-    return phase1 + "\n\n---\n\n" + phase2 + "\n"
-
 
 def unsubscribe_threads(
     months: int,

repomatic/templates/available-admonition.md

@@ -1,5 +1,6 @@
 ---
 args: [version, verb, platforms]
+footer: false
 ---
 
 > [!NOTE]

repomatic/templates/broken-links-issue.md

@@ -7,7 +7,3 @@ args: [lychee_section, sphinx_section]
 \$lychee_section
 
 \$sphinx_section
-
----
-
-🏭 Generated with [repomatic](https://github.com/kdeldycke/repomatic)

repomatic/templates/bump-version.md

@@ -1,6 +1,7 @@
 ---
 args: [version, part]
 title: Bump $part version to `v$version`
+footer: false
 ---
 
 ### Description

repomatic/templates/detect-squash-merge.md

@@ -1,6 +1,7 @@
 ---
 args: [pr_ref]
 title: 🚨 Squash merge detected — release skipped
+footer: false
 ---
 
 ### Summary

repomatic/templates/development-warning.md

@@ -1,2 +1,6 @@
+---
+footer: false
+---
+
 > [!WARNING]
 > This version is **not released yet** and is under active development.

repomatic/templates/fix-changelog.md

@@ -1,5 +1,6 @@
 ---
 title: Fix changelog
+footer: false
 ---
 
 ### Description

repomatic/templates/fix-typos.md

@@ -1,5 +1,6 @@
 ---
 title: Typo
+footer: false
 ---
 
 ### Description