mkdocs2confluence 0.20.3__tar.gz → 0.20.4__tar.gz

{mkdocs2confluence-0.20.3/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.20.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.20.3
+Version: 0.20.4
 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

{mkdocs2confluence-0.20.3 → mkdocs2confluence-0.20.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.20.3"
+version = "0.20.4"
 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" }

{mkdocs2confluence-0.20.3 → mkdocs2confluence-0.20.4/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.20.3
+Version: 0.20.4
 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

{mkdocs2confluence-0.20.3 → mkdocs2confluence-0.20.4}/src/mkdocs_to_confluence/compiler/page.py

@@ -7,7 +7,7 @@ from mkdocs_to_confluence.emitter.xhtml import emit
 from mkdocs_to_confluence.ir.nodes import ChildrenMacro, FrontMatter, SourceFooter
 from mkdocs_to_confluence.loader.config import MkDocsConfig
 from mkdocs_to_confluence.loader.nav import NavNode
-from mkdocs_to_confluence.loader.page import load_page
+from mkdocs_to_confluence.loader.page import PageLoadError, load_page
 from mkdocs_to_confluence.parser.markdown import parse, parse_inline
 from mkdocs_to_confluence.preprocess.abbrevs import (
     extract_abbreviations,
@@ -52,10 +52,11 @@ def compile_page(
     quiet: bool = False,
 ) -> CompileResult:
     """Run the full compile pipeline for one page and return a typed result."""
-    if node.source_path is None:
-        return CompileResult(xhtml="")
-
+    # load_page raises PageLoadError for a nav entry whose file is missing;
+    # never compile it to an empty body, which would blank the published page.
     raw = load_page(node)
+    if node.source_path is None:  # unreachable after load_page; narrows the type
+        raise PageLoadError(f"Cannot load page '{node.title}': no source file.")
 
     preprocessed = preprocess_includes(
         raw,

{mkdocs2confluence-0.20.3 → mkdocs2confluence-0.20.4}/src/mkdocs_to_confluence/publisher/planner.py

@@ -47,6 +47,29 @@ def _find_section_index(node: NavNode) -> NavNode | None:
     return None
 
 
+def _plan_skipped_page_action(
+    node: NavNode,
+    client: ConfluenceClient,
+    *,
+    space_id: str,
+    title: str,
+    parent_id: str | None,
+) -> PageAction:
+    """Build a skip action for a nav page that is not being published this run.
+
+    Carries the existing page's ID so ``--prune`` keeps it: the page is still
+    in ``nav:``, only skipped (``ready: false`` or a load error).
+    """
+    existing = client.find_page(space_id, title)
+    return PageAction(
+        node=node,
+        title=title,
+        action="skip",
+        parent_id=parent_id,
+        page_id=str(existing["id"]) if existing is not None else None,
+    )
+
+
 def _plan_compiled_page_action(
     node: NavNode,
     client: ConfluenceClient,
@@ -231,11 +254,8 @@ def _plan_nodes(
                 if not quiet:
                     print(f"  skipping   '{clean_title}'  (ready: false)")
                 actions.append(
-                    PageAction(
-                        node=node,
-                        title=clean_title,
-                        action="skip",
-                        parent_id=parent_id,
+                    _plan_skipped_page_action(
+                        node, client, space_id=space_id, title=clean_title, parent_id=parent_id
                     )
                 )
                 continue
@@ -248,11 +268,8 @@ def _plan_nodes(
                 if not quiet:
                     print(f"  skipping   '{clean_title}'  (error: {exc})")
                 actions.append(
-                    PageAction(
-                        node=node,
-                        title=clean_title,
-                        action="skip",
-                        parent_id=parent_id,
+                    _plan_skipped_page_action(
+                        node, client, space_id=space_id, title=clean_title, parent_id=parent_id
                     )
                 )
                 continue

{mkdocs2confluence-0.20.3 → mkdocs2confluence-0.20.4}/tests/test_publish_pipeline.py

@@ -78,16 +78,13 @@ def test_compile_page_with_ready_false_still_compiles(tmp_path: Path) -> None:
     assert isinstance(xhtml, str)
 
 
-def test_compile_page_with_source_path_none_returns_empty(tmp_path: Path) -> None:
-    docs = tmp_path / "docs"
-    docs.mkdir()
+def test_compile_page_raises_for_missing_source(tmp_path: Path) -> None:
+    # An empty result would be published over the existing page, blanking it.
+    from mkdocs_to_confluence.loader.page import PageLoadError
+
     node = NavNode(title="Missing", docs_path="missing.md", source_path=None, level=0)
-    config = _make_config(docs)
-    result = compile_page(node, config)
-    xhtml, attachments, labels = result.xhtml, result.attachments, result.labels
-    assert xhtml == ""
-    assert attachments == []
-    assert labels == ()
+    with pytest.raises(PageLoadError, match="Missing"):
+        compile_page(node, _make_config(tmp_path))
 
 
 def test_compile_page_excludes_configured_properties(tmp_path: Path) -> None:
@@ -2211,3 +2208,43 @@ def test_execute_publish_calls_set_page_status_on_skip(tmp_path: Path) -> None:
     execute_publish([action], client, space_id="42", docs_dir=tmp_path)
 
     client.set_page_status.assert_called_once_with("88", "in-progress", space_key=None)
+
+
+class TestSkippedPagesSurvivePrune:
+    """A page still in nav: but skipped this run must keep its Confluence page."""
+
+    @staticmethod
+    def _publish_with_prune(node: NavNode, docs: Path) -> tuple[list[PageAction], MagicMock]:
+        from mkdocs_to_confluence.publisher.executor import execute_publish
+
+        client = MagicMock()
+        client.find_page.return_value = {"id": "555", "version": {"number": 3}}
+        client.get_descendant_ids.return_value = ["555"]
+        client.is_managed.return_value = True
+        plan, _ = plan_publish([node], client, _make_config(docs), _make_conf_config(), space_id="42", quiet=True)
+        execute_publish(plan, client, space_id="42", docs_dir=docs, root_page_id="ROOT", prune=True, quiet=True)
+        return plan, client
+
+    def test_ready_false_page_is_kept(self, tmp_path: Path) -> None:
+        docs = tmp_path / "docs"
+        docs.mkdir()
+        md = docs / "guide.md"
+        md.write_text("---\nready: false\n---\n\n# Guide\n", encoding="utf-8")
+
+        plan, client = self._publish_with_prune(_page_node("Guide", md), docs)
+
+        assert [(a.action, a.page_id) for a in plan] == [("skip", "555")]
+        client.delete_page.assert_not_called()
+
+    def test_missing_file_is_skipped_not_blanked(self, tmp_path: Path) -> None:
+        # A nav entry whose file is gone (e.g. renamed) must not publish an
+        # empty body over the existing page, nor let prune delete it.
+        docs = tmp_path / "docs"
+        docs.mkdir()
+        node = NavNode(title="Guide", docs_path="guide.md", source_path=None, level=0)
+
+        plan, client = self._publish_with_prune(node, docs)
+
+        assert [(a.action, a.page_id) for a in plan] == [("skip", "555")]
+        client.update_page.assert_not_called()
+        client.delete_page.assert_not_called()