Merge branch 'main' into bug-dont-check-external-mds

Author: tristanls

tools/github_readme_sync/README.md

@@ -36,7 +36,7 @@ export IMAGE_PATH=thousandbrainsproject/tbp.monty/refs/heads/main/docs/figures
 ```
 > python -m tools.github_readme_sync.cli -h
 
-usage: cli.py [-h] {export,check,upload,check-external} ...
+usage: cli.py [-h] {export,check,upload,check-external,delete} ...
 
 CLI tool to manage exporting, checking, and uploading docs.
 
@@ -46,6 +46,7 @@ positional arguments:
     check               Check the hierarchy.md file and ensure all docs exist
     upload              Upload the docs in the folder to ReadMe under the specified version
     check-external      Check external links in all markdown files from the specified directory
+    delete              Delete a specific version from ReadMe
 
 optional arguments:
   -h, --help            show this help message and exit

tools/github_readme_sync/cli.py

@@ -78,6 +78,12 @@ def main():
         help="List of directories to exclude from link checking",
     )
 
+    # Delete version command
+    delete_parser = subparsers.add_parser(
+        "delete", help="Delete a specific version from ReadMe"
+    )
+    delete_parser.add_argument("version", help="The version to delete")
+
     args = parser.parse_args()
 
     initialize()
@@ -99,6 +105,11 @@ def main():
         check_readme_api_key()
         check_external(args.folder, args.ignore, ReadMe(args.version))
 
+    elif args.command == "delete":
+        check_readme_api_key()
+        rdme = ReadMe(args.version)
+        rdme.delete_version()
+
 
 def check_readme_api_key():
     if not os.getenv("README_API_KEY"):

tools/github_readme_sync/readme.py

@@ -230,11 +230,11 @@ def replace_path(match):
 
     def convert_note_tags(self, body: str) -> str:
         conversions = {
-            r">\s*\[!NOTE\]\s*": "> 📘 ",
-            r">\s*\[!TIP\]\s*": "> 👍 ",
-            r">\s*\[!IMPORTANT\]\s*": "> 📘 ",
-            r">\s*\[!WARNING\]\s*": "> 🚧 ",
-            r">\s*\[!CAUTION\]\s*": "> ❗️ ",
+            r"\[!NOTE\]": "📘",
+            r"\[!TIP\]": "👍",
+            r"\[!IMPORTANT\]": "📘",
+            r"\[!WARNING\]": "🚧",
+            r"\[!CAUTION\]": "❗️",
         }
 
         for old, new in conversions.items():
@@ -272,6 +272,10 @@ def replace_image(match):
 
         return regex_images.sub(replace_image, markdown_text)
 
+    def delete_version(self):
+        delete(f"{PREFIX}/version/v{self.version}")
+        logging.info(f"{GREEN}Successfully deleted version {self.version}{RESET}")
+
     def convert_cloudinary_videos(self, markdown_text: str) -> str:
         def replace_video(match):
             title, full_url, cloud_id, version, filename = match.groups()

tools/github_readme_sync/tests/readme_test.py

@@ -429,7 +429,24 @@ def test_correct_image_locations_no_repo_env(self):
             str(context.exception), "IMAGE_PATH environment variable not set"
         )
 
-    def test_convert_note_tags(self):
+    def test_convert_note_tags_with_link(self):
+        input_text = """
+        > [!NOTE]
+        > You can find our code at https://github.com/thousandbrainsproject/tbp.monty
+        >
+        > This is our open-source repository. We call it **Monty** after
+        """
+
+        expected_output = """
+        > 📘
+        > You can find our code at https://github.com/thousandbrainsproject/tbp.monty
+        >
+        > This is our open-source repository. We call it **Monty** after
+        """
+
+        self.assertEqual(
+            self.readme.convert_note_tags(input_text).strip(), expected_output.strip()
+        )
         input_text = """
         > [!NOTE]    This is a note.
         >   [!TIP]    Here's a tip.
@@ -439,10 +456,10 @@ def test_convert_note_tags(self):
         """
 
         expected_output = """
-        > 📘 This is a note.
-        > 👍 Here's a tip.
-        > 📘 This is important.
-        > 🚧 This is a warning.
+        > 📘    This is a note.
+        >   👍    Here's a tip.
+        > 📘  This is important.
+        >     🚧 This is a warning.
         > ❗️ Be cautious!
         """
 

tools/github_readme_sync/tests/req_test.py

@@ -11,6 +11,7 @@
 import unittest
 from unittest.mock import MagicMock, patch
 
+from tools.github_readme_sync.readme import ReadMe
 from tools.github_readme_sync.req import delete, get, post, put
 
 
@@ -159,6 +160,23 @@ def test_delete_failure(self, mock_delete):
             url, headers={"Authorization": "Basic test_api_key"}
         )
 
+    @patch("requests.delete")
+    def test_delete_version(self, mock_delete):
+        mock_response = MagicMock()
+        mock_response.status_code = 204
+        mock_delete.return_value = mock_response
+
+        url = "https://dash.readme.com/api/v1/version/v1.0.0"
+
+        rdme = ReadMe("1.0.0")
+        with self.assertLogs() as log:
+            rdme.delete_version()
+
+        self.assertIn("Successfully deleted version 1.0.0", log.output[0])
+        mock_delete.assert_called_once_with(
+            url, headers={"Authorization": "Basic test_api_key"}
+        )
+
 
 if __name__ == "__main__":
     unittest.main()