mkdocs2confluence 0.17.4__tar.gz → 0.18.1__tar.gz

{mkdocs2confluence-0.17.4/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.18.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.17.4
+Version: 0.18.1
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -35,7 +35,7 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
-Requires-Dist: bandit; extra == "dev"
+Requires-Dist: bandit[sarif]; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Dynamic: license-file
@@ -161,6 +161,7 @@ confluence:
   mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none" — also controls PlantUML rendering
   full_width: true                   # default: true
   attachment_preview: false          # default: false — inline PDF/Office previews
+  children_macro: true               # default: true — child page list on section index pages
   changelog: CHANGELOG.md           # optional: publish as a top-level "What's New" page
   exclude_properties:                # optional: front matter keys to hide from Page Properties
     - source_documents
@@ -171,6 +172,8 @@ confluence:
 
 `attachment_preview` (bool, default `false`) renders links to local PDF/Office files (`.pdf`, `.doc(x)`, `.xls(x)`, `.ppt(x)`) as inline `view-file` previews instead of download links. Other file types always remain download links.
 
+`children_macro` (bool, default `true`) controls the native Children Display macro appended to section index pages (a nav section with an `index.md`). Set it to `false` to publish those pages without the auto-generated child page list; the change takes effect on the next publish.
+
 The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
 
 ### Changelog / What's New page

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/README.md

@@ -119,6 +119,7 @@ confluence:
   mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none" — also controls PlantUML rendering
   full_width: true                   # default: true
   attachment_preview: false          # default: false — inline PDF/Office previews
+  children_macro: true               # default: true — child page list on section index pages
   changelog: CHANGELOG.md           # optional: publish as a top-level "What's New" page
   exclude_properties:                # optional: front matter keys to hide from Page Properties
     - source_documents
@@ -129,6 +130,8 @@ confluence:
 
 `attachment_preview` (bool, default `false`) renders links to local PDF/Office files (`.pdf`, `.doc(x)`, `.xls(x)`, `.ppt(x)`) as inline `view-file` previews instead of download links. Other file types always remain download links.
 
+`children_macro` (bool, default `true`) controls the native Children Display macro appended to section index pages (a nav section with an `index.md`). Set it to `false` to publish those pages without the auto-generated child page list; the change takes effect on the next publish.
+
 The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
 
 ### Changelog / What's New page

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.17.4"
+version = "0.18.1"
 description = "Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }
@@ -52,7 +52,7 @@ dev = [
   "ruff",
   "mypy",
   "types-PyYAML",
-  "bandit",
+  "bandit[sarif]",
   "build",
   "pre-commit",
 ]
@@ -74,7 +74,22 @@ where = ["src"]
 line-length = 120
 
 [tool.ruff.lint]
-select = ["E", "F", "I"]
+# S = flake8-bandit (security), B = flake8-bugbear (likely bugs).
+select = ["E", "F", "I", "S", "B"]
+ignore = [
+  # Deliberate throughout: best-effort side effects (content hashes, managed-page
+  # stamps) whose failure is self-healing on the next run. Each site says so.
+  "S110",  # try-except-pass
+  # Fixed argument lists only — `git log` in the footer transform and the macOS
+  # DYLD self-re-exec in cli.py. No user input reaches a subprocess.
+  "S603", "S606", "S607",
+  # Retry jitter in http_retry.py, not a security context.
+  "S311",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Tests assert freely and use throwaway credentials in fixtures.
+"tests/**" = ["S101", "S105", "S106", "S107"]
 
 [tool.mypy]
 strict = true
@@ -104,7 +119,7 @@ exclude_lines = [
 ]
 
 # Architecture boundaries — enforces the compile pipeline stage separation
-# documented in .github/copilot-instructions.md. Higher layers may import lower
+# documented in AGENTS.md. Higher layers may import lower
 # ones; siblings joined by "|" must stay independent of each other.
 [tool.importlinter]
 root_package = "mkdocs_to_confluence"

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.17.4
+Version: 0.18.1
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -35,7 +35,7 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
-Requires-Dist: bandit; extra == "dev"
+Requires-Dist: bandit[sarif]; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Dynamic: license-file
@@ -161,6 +161,7 @@ confluence:
   mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none" — also controls PlantUML rendering
   full_width: true                   # default: true
   attachment_preview: false          # default: false — inline PDF/Office previews
+  children_macro: true               # default: true — child page list on section index pages
   changelog: CHANGELOG.md           # optional: publish as a top-level "What's New" page
   exclude_properties:                # optional: front matter keys to hide from Page Properties
     - source_documents
@@ -171,6 +172,8 @@ confluence:
 
 `attachment_preview` (bool, default `false`) renders links to local PDF/Office files (`.pdf`, `.doc(x)`, `.xls(x)`, `.ppt(x)`) as inline `view-file` previews instead of download links. Other file types always remain download links.
 
+`children_macro` (bool, default `true`) controls the native Children Display macro appended to section index pages (a nav section with an `index.md`). Set it to `false` to publish those pages without the auto-generated child page list; the change takes effect on the next publish.
+
 The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
 
 ### Changelog / What's New page

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs2confluence.egg-info/requires.txt

@@ -9,7 +9,7 @@ pytest-cov
 ruff
 mypy
 types-PyYAML
-bandit
+bandit[sarif]
 build
 pre-commit
 

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/cli.py

@@ -274,7 +274,7 @@ def _build_parser() -> argparse.ArgumentParser:
             "Detected targets (all installed when no --tool given):\n"
             "  hermes        ~/.hermes/skills/tooling/mkdocs-changelog/SKILL.md\n"
             "  github-skills .github/skills/tooling/mkdocs-changelog/SKILL.md\n"
-            "  claude        .claude/commands/changelog.md  (frontmatter stripped)\n"
+            "  claude        .claude/commands/mk2conf-changelog.md  (frontmatter stripped)\n"
             "  copilot       .github/instructions/mk2conf-changelog.instructions.md\n"
             "  cursor        .cursor/rules/mk2conf-changelog.mdc\n"
             "\n"

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/compiler/page.py

@@ -79,7 +79,7 @@ def compile_page(
     preprocessed = strip_link_defs(preprocessed)
     ir_nodes = parse(preprocessed)
     ir_nodes = strip_links_in_admonition_titles(ir_nodes, node.docs_path or "")
-    if is_section_index:
+    if is_section_index and (config.confluence is None or config.confluence.children_macro):
         ir_nodes = ir_nodes + (ChildrenMacro(),)
     # Parse definitions as inline markdown so links etc. survive into the glossary.
     parsed_abbrevs = {abbr: parse_inline(defn) for abbr, defn in abbrevs.items()}

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/loader/config.py

@@ -37,6 +37,7 @@ class ConfluenceConfig:
     changelog_file: str | None = None  # path relative to docs_dir; None means disabled
     exclude_properties: tuple[str, ...] = ()  # front matter keys to omit from Page Properties table
     attachment_preview: bool = False  # render PDF/Office attachment links as view-file macros
+    children_macro: bool = True  # append Children Display macro to section index pages
 
 
 @dataclass(frozen=True)
@@ -153,7 +154,11 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
         raise FileNotFoundError(f"mkdocs.yml not found: {mkdocs_yml}")
 
     with mkdocs_yml.open(encoding="utf-8") as fh:
-        raw: object = yaml.load(fh, Loader=_make_env_loader())  # nosec B506
+        # B506 is suppressed below because _make_env_loader() returns a
+        # yaml.SafeLoader subclass — this is a safe load. Bandit cannot resolve the
+        # loader through the function call, so it assumes the worst. Removing the
+        # suppression reintroduces a medium-severity finding that fails CI.
+        raw: object = yaml.load(fh, Loader=_make_env_loader())  # noqa: S506  # nosec B506
 
     if not isinstance(raw, dict):
         raise ConfigError("mkdocs.yml must be a YAML mapping at the top level.")
@@ -275,7 +280,7 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
                     raise ConfigError(
                         f"mkdocs.yml: 'confluence.changelog' path {cl_str!r} "
                         "escapes docs_dir. The path must be relative to the docs directory."
-                    )
+                    ) from None
                 changelog_file = cl_str
 
         # exclude_properties (optional) — raw front matter keys to omit from
@@ -300,6 +305,15 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
             )
         attachment_preview = raw_preview
 
+        # children_macro (optional) — child page list on section index pages
+        raw_children = raw_conf.get("children_macro", True)
+        if not isinstance(raw_children, bool):
+            raise ConfigError(
+                "mkdocs.yml: 'confluence.children_macro' must be a boolean, "
+                f"got {type(raw_children).__name__}."
+            )
+        children_macro = raw_children
+
         confluence = ConfluenceConfig(
             base_url=base_url.rstrip("/"),
             space_key=space_key,
@@ -317,6 +331,7 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
             changelog_file=changelog_file,
             exclude_properties=exclude_properties,
             attachment_preview=attachment_preview,
+            children_macro=children_macro,
         )
 
     # --- extra_css (optional) ---

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/parser/markdown.py

@@ -1207,7 +1207,9 @@ def _build_tree(
             def _make_cell(
                 text: str, col: int, is_header: bool = False
             ) -> TableCell:
-                align = aligns[col] if col < len(aligns) else None
+                # B023 is suppressed below: _make_cell is defined and fully consumed
+                # inside a single loop iteration, so aligns cannot be rebound under it.
+                align = aligns[col] if col < len(aligns) else None  # noqa: B023
                 return TableCell(
                     children=_parse_inline(text, fn_map=_fn),
                     align=align,

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/preprocess/includes.py

@@ -294,7 +294,7 @@ def _parse_spec(
             raise IncludeError(
                 f"{source_path}:{lineno}: named-section includes are not yet "
                 f"supported: {raw_spec!r}"
-            )
+            ) from None
         if start < 1 or end < start:
             raise IncludeError(
                 f"{source_path}:{lineno}: invalid line range {start}:{end} "

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/publisher/client.py

@@ -7,6 +7,7 @@ Authentication is HTTP Basic with email + API token.
 from __future__ import annotations
 
 import base64
+from functools import partial
 from pathlib import Path
 from typing import Any, cast
 from urllib.parse import parse_qs, urlparse
@@ -378,7 +379,9 @@ class ConfluenceClient:
                 name = lbl.get("name", "")
                 if name:
                     http_request_with_retry(
-                        lambda: self._http.delete(label_url, params={"name": name}),
+                        # partial binds name now; a closure would late-bind and could
+                        # delete the wrong label if the helper ever defers the call.
+                        partial(self._http.delete, label_url, params={"name": name}),
                         f"set_page_labels({page_id!r})",
                     )
 

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/skill_installer.py

@@ -90,13 +90,13 @@ def install_skill(
             dest.write_text(content_body, encoding="utf-8")
             installed.append(("claude", dest))
 
-    # GitHub Copilot — project-level, body only as .instructions.md
+    # GitHub Copilot — .instructions.md needs applyTo frontmatter or Copilot ignores it
     if _want("copilot"):
         copilot_marker = project_dir / ".github" / "copilot-instructions.md"
         if explicit or copilot_marker.exists():
             dest = project_dir / ".github" / "instructions" / "mk2conf-changelog.instructions.md"
             dest.parent.mkdir(parents=True, exist_ok=True)
-            dest.write_text(content_body, encoding="utf-8")
+            dest.write_text(f'---\napplyTo: "**"\n---\n\n{content_body}', encoding="utf-8")
             installed.append(("copilot", dest))
 
     # Cursor — project-level, body as .mdc

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/transforms/_kroki.py

@@ -53,7 +53,10 @@ def kroki_post(source: str, diagram_type: str, kroki_url: str, fmt: str = "png")
     """POST *source* to Kroki for *diagram_type* and return rendered bytes."""
     url = f"{kroki_url.rstrip('/')}/{diagram_type}/{fmt}"
     body = source.encode("utf-8")
-    req = urllib.request.Request(
+    # kroki_url comes from config, so the scheme is not attacker-controlled, but it is
+    # also not validated. Switching this to httpx (already a dependency) would restrict
+    # it to http/https and remove the urllib import entirely.
+    req = urllib.request.Request(  # noqa: S310
         url,
         data=body,
         headers={

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/src/mkdocs_to_confluence/transforms/mermaid.py

@@ -62,7 +62,7 @@ def _mermaid_ink_png(source: str) -> bytes:
     compressed = zlib.compress(payload.encode("utf-8"))
     encoded = base64.urlsafe_b64encode(compressed).decode().rstrip("=")
     url = f"{_MERMAID_INK_URL}/img/pako:{encoded}?type=png"
-    req = urllib.request.Request(url, headers={"User-Agent": "mk2conf/1.0"})
+    req = urllib.request.Request(url, headers={"User-Agent": "mk2conf/1.0"})  # noqa: S310
     with urllib.request.urlopen(req, timeout=_TIMEOUT) as resp:  # noqa: S310  # nosec B310
         return cast(bytes, resp.read())
 

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/tests/test_children_macro.py

@@ -92,9 +92,89 @@ def test_compile_page_children_macro_before_footer(tmp_path: Path) -> None:
     assert children_pos < panel_pos
 
 
+# ── children_macro config flag ────────────────────────────────────────────────
+
+
+def test_children_macro_disabled_omits_macro(tmp_path: Path) -> None:
+    """confluence.children_macro=false must suppress the macro on section indexes."""
+    xhtml = _compile_index(tmp_path, children_macro=False)
+
+    assert 'ac:name="children"' not in xhtml
+
+
+def test_children_macro_enabled_by_default(tmp_path: Path) -> None:
+    """A confluence block without children_macro must keep the macro."""
+    xhtml = _compile_index(tmp_path, children_macro=True)
+
+    assert 'ac:name="children"' in xhtml
+
+
+def test_children_macro_config_default_true(tmp_path: Path) -> None:
+    from mkdocs_to_confluence.loader.config import load_config
+
+    cfg = load_config(_write_mkdocs(tmp_path, _CONF))
+    assert cfg.confluence.children_macro is True
+
+
+def test_children_macro_config_false(tmp_path: Path) -> None:
+    from mkdocs_to_confluence.loader.config import load_config
+
+    cfg = load_config(_write_mkdocs(tmp_path, _CONF + "  children_macro: false\n"))
+    assert cfg.confluence.children_macro is False
+
+
+def test_children_macro_config_non_bool_raises(tmp_path: Path) -> None:
+    import pytest
+
+    from mkdocs_to_confluence.loader.config import ConfigError, load_config
+
+    with pytest.raises(ConfigError, match="children_macro"):
+        load_config(_write_mkdocs(tmp_path, _CONF + "  children_macro: maybe\n"))
+
+
 # ── Helpers ───────────────────────────────────────────────────────────────────
 
 
+_CONF = (
+    "confluence:\n"
+    "  base_url: https://x.atlassian.net/wiki\n"
+    "  email: a@b.test\n"
+    "  space_key: TECH\n"
+)
+
+
+def _write_mkdocs(tmp_path: Path, extra: str = "") -> Path:
+    (tmp_path / "docs").mkdir()
+    (tmp_path / "mkdocs.yml").write_text(f"site_name: Test Site\n{extra}", encoding="utf-8")
+    return tmp_path / "mkdocs.yml"
+
+
+def _compile_index(tmp_path: Path, *, children_macro: bool) -> str:
+    """Compile a section index page with a confluence block set to *children_macro*."""
+    from mkdocs_to_confluence.loader.config import ConfluenceConfig, MkDocsConfig
+
+    docs = tmp_path / "docs"
+    docs.mkdir()
+    md = docs / "index.md"
+    md.write_text("# Section\n\nIntro.\n", encoding="utf-8")
+
+    config = MkDocsConfig(
+        site_name="Test",
+        docs_dir=docs,
+        repo_url=None,
+        edit_uri=None,
+        nav=None,
+        confluence=ConfluenceConfig(
+            base_url="https://x.atlassian.net/wiki",
+            email="a@b.test",
+            token="",
+            space_key="TECH",
+            children_macro=children_macro,
+        ),
+    )
+    return compile_page(_page_node("Section", md), config, is_section_index=True).xhtml
+
+
 def _page_node(title: str, path: Path) -> object:
     from mkdocs_to_confluence.loader.nav import NavNode
 

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.1}/tests/test_skill_installer.py

@@ -64,6 +64,8 @@ def test_install_skill_copilot(tmp_path: Path) -> None:
     assert dest.name == "mk2conf-changelog.instructions.md"
     content = dest.read_text(encoding="utf-8")
     assert "name: mkdocs-changelog" not in content
+    # Copilot ignores .instructions.md files without applyTo frontmatter
+    assert content.startswith('---\napplyTo: "**"\n---\n\n# MkDocs Changelog Entry')
 
 
 def test_install_skill_cursor(tmp_path: Path) -> None: