Merge main

canonical · Jan 19, 2024 · 90a9a5a · 90a9a5a
2 parents 9e1e164 + 24675f6
commit 90a9a5a
Show file tree

Hide file tree

Showing 64 changed files with 162 additions and 81 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@
 - Added a formatted representation of the UpdatePageAction dataclass for more
   human-readable output.
 
+## [v0.8.1] - 2024-01-18
+
+### Fixed
+
+- Migration error where discourse is in-line with the default branch but the
+  base content tag is behind. This no longer attempts migration and now also
+  moves the tag to the latest commit on the default branch.
+
 ## [v0.8.0] - 2023-11-30
 
 ### Added

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 FROM python:3.11-slim
 

diff --git a/action.yaml b/action.yaml
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 name: Upload Charm Docs
 description: Upload charm documentation to charmhub

diff --git a/generate-src-docs.sh b/generate-src-docs.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 rm -rf src-docs

diff --git a/main.py b/main.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Main execution for the action."""

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 [tool.bandit]

diff --git a/src-docs/__init__.py.md b/src-docs/__init__.py.md
@@ -76,7 +76,7 @@ Migrate existing docs from charmhub to local repository.
 
 ---
 
-<a href="../src/__init__.py#L251"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/__init__.py#L259"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `pre_flight_checks`
 

diff --git a/src/__init__.py b/src/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Library for uploading docs to charmhub."""
@@ -133,7 +133,7 @@ def run_reconcile(clients: Clients, user_inputs: UserInputs) -> ReconcileOutputs
             index_url=index.server.url if index.server else "",
             topics=(
                 {
-                    f"{clients.discourse.absolute_url(row.navlink.link)}": ActionResult.SKIP
+                    clients.discourse.absolute_url(row.navlink.link): ActionResult.SKIP
                     for row in table_rows
                     if row.navlink.link
                 }
@@ -221,11 +221,19 @@ def run_migrate(clients: Clients, user_inputs: UserInputs) -> MigrateOutputs | N
 
     # Check difference with main
     changes = recreate_docs(clients, DOCUMENTATION_TAG)
+    # Check whether there are still changes after switching to the base branch
+    if changes:
+        changes = clients.repository.is_dirty(user_inputs.base_branch)
+
+        # Move the tag if there are no changes
+        if not changes:
+            with clients.repository.with_branch(user_inputs.base_branch) as repo:
+                main_hash = repo.current_commit
+            clients.repository.tag_commit(DOCUMENTATION_TAG, main_hash)
+
     if not changes:
         logging.info(
-            "No community contribution found in commit %s. Discourse is inline with %s",
-            user_inputs.commit_sha,
-            DOCUMENTATION_TAG,
+            "No community contribution found, discourse is inline with %s", DOCUMENTATION_TAG
         )
         # Given there are NO diffs compared to the base, if a PR is open, it should be closed
         if pull_request is not None:

diff --git a/src/action.py b/src/action.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for taking the required actions to match the server state with the local state."""

diff --git a/src/check.py b/src/check.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for running checks."""

diff --git a/src/clients.py b/src/clients.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for Client class."""

diff --git a/src/commit.py b/src/commit.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for handling interactions with git commit."""

diff --git a/src/constants.py b/src/constants.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Shared constants.

diff --git a/src/content.py b/src/content.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for checking conflicts using 3-way merge and create content based on a 3 way merge."""

diff --git a/src/discourse.py b/src/discourse.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Interface for Discourse interactions."""

diff --git a/src/docs_directory.py b/src/docs_directory.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Class for reading the docs directory."""

diff --git a/src/download.py b/src/download.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Library for downloading docs folder from charmhub."""

diff --git a/src/exceptions.py b/src/exceptions.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Exceptions for uploading docs to charmhub."""

diff --git a/src/index.py b/src/index.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Execute the uploading of documentation."""

diff --git a/src/metadata.py b/src/metadata.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for parsing metadata.yaml file."""

diff --git a/src/migration.py b/src/migration.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for migrating remote documentation into local git repository."""

diff --git a/src/navigation_table.py b/src/navigation_table.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for parsing and rendering a navigation table."""

diff --git a/src/reconcile.py b/src/reconcile.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for calculating required changes based on docs directory and navigation table."""

diff --git a/src/repository.py b/src/repository.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module for handling interactions with git repository."""

diff --git a/src/sort.py b/src/sort.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Sort items for publishing."""

diff --git a/src/types_.py b/src/types_.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Types for uploading docs to charmhub."""

diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Tests for uploading docs to charmhub."""
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for all tests."""

diff --git a/tests/factories.py b/tests/factories.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Factories for generating test data."""
@@ -337,7 +337,7 @@ class Meta:
         abstract = False
 
     hostname = factory.Sequence(lambda n: f"discourse/{n}")
-    category_id = factory.Sequence(lambda n: f"{n}")
+    category_id = factory.Sequence(str)
     api_username = factory.Sequence(lambda n: f"discourse-test-user-{n}")
     api_key = factory.Sequence(lambda n: f"discourse-test-key-{n}")
 

diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Unit tests for uploading docs to charmhub."""
diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for integration tests."""

diff --git a/tests/integration/test___init__run_conflict.py b/tests/integration/test___init__run_conflict.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for running the action where there is a merge conflict."""
@@ -77,7 +77,7 @@ async def test_run_conflict(
     caplog.clear()
     index_url = discourse_api.create_topic(
         title=f"{document_name.replace('-', ' ').title()} Documentation Overview",
-        content=f"{constants.NAVIGATION_TABLE_START}".strip(),
+        content=constants.NAVIGATION_TABLE_START.strip(),
     )
     create_metadata_yaml(
         content=f"{metadata.METADATA_NAME_KEY}: name 1\n{metadata.METADATA_DOCS_KEY}: {index_url}",

diff --git a/tests/integration/test___init__run_migrate.py b/tests/integration/test___init__run_migrate.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for running the migrate action."""
@@ -246,8 +246,8 @@ def mock_edit(*args, **kwargs):  # pylint: disable=W0613
     assert output_migrate.action == PullRequestAction.CLOSED
     assert_substrings_in_string(
         [
-            "No community contribution found in commit",
-            f"Discourse is inline with {DOCUMENTATION_TAG}",
+            "No community contribution found",
+            f"discourse is inline with {DOCUMENTATION_TAG}",
         ],
         caplog.text,
     )
diff --git a/tests/integration/test___init__run_reconcile.py b/tests/integration/test___init__run_reconcile.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for running the reconcile portion of the action."""
@@ -89,7 +89,7 @@ async def test_run(
     caplog.clear()
     index_url = discourse_api.create_topic(
         title=f"{document_name.replace('-', ' ').title()} Documentation Overview",
-        content=f"{constants.NAVIGATION_TABLE_START}".strip(),
+        content=constants.NAVIGATION_TABLE_START.strip(),
     )
     create_metadata_yaml(
         content=f"{metadata.METADATA_NAME_KEY}: name 1\n{metadata.METADATA_DOCS_KEY}: {index_url}",
@@ -114,7 +114,7 @@ async def test_run(
     assert output_reconcile is not None
     assert output_reconcile.index_url == index_url
     index_topic = discourse_api.retrieve_topic(url=index_url)
-    assert index_topic == f"{constants.NAVIGATION_TABLE_START}".strip()
+    assert index_topic == constants.NAVIGATION_TABLE_START.strip()
     assert_substrings_in_string((index_url, "Update", "'skip'"), caplog.text)
     mock_github_repo.create_git_ref.assert_not_called()
 
@@ -508,7 +508,7 @@ async def test_run_hidden(
     caplog.clear()
     index_url = discourse_api.create_topic(
         title=f"{document_name.replace('-', ' ').title()} Documentation Overview",
-        content=f"{constants.NAVIGATION_TABLE_START}".strip(),
+        content=constants.NAVIGATION_TABLE_START.strip(),
     )
     create_metadata_yaml(
         content=f"{metadata.METADATA_NAME_KEY}: name 1\n{metadata.METADATA_DOCS_KEY}: {index_url}",
@@ -747,7 +747,7 @@ async def test_run_external(
     caplog.clear()
     index_url = discourse_api.create_topic(
         title=f"{document_name.replace('-', ' ').title()} Documentation Overview",
-        content=f"{constants.NAVIGATION_TABLE_START}".strip(),
+        content=constants.NAVIGATION_TABLE_START.strip(),
     )
     create_metadata_yaml(
         content=f"{metadata.METADATA_NAME_KEY}: name 1\n{metadata.METADATA_DOCS_KEY}: {index_url}",

diff --git a/tests/integration/test_discourse.py b/tests/integration/test_discourse.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for discourse."""

diff --git a/tests/integration/types.py b/tests/integration/types.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Useful types for integration tests."""

diff --git a/tests/types.py b/tests/types.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Useful types for tests."""

diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Unit tests for uploading docs to charmhub."""
diff --git a/tests/unit/action/__init__.py b/tests/unit/action/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Unit tests for actions."""
diff --git a/tests/unit/action/test_other_actions.py b/tests/unit/action/test_other_actions.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Unit tests for action."""

diff --git a/tests/unit/action/test_update_action.py b/tests/unit/action/test_update_action.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Unit tests for action."""

diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for all unit tests."""

diff --git a/tests/unit/helpers.py b/tests/unit/helpers.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Helper functions for tests."""
-Original file line number
+Diff line change
@@ Expand Up / @@ -76,7 +76,7 @@ Migrate existing docs from charmhub to local repository. @@
     ---
-    <a href="../src/__init__.py#L251"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+    <a href="../src/__init__.py#L259"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
     ## <kbd>function</kbd> `pre_flight_checks`
@@ Expand Down @@