Create tag and release

.github/workflows/cd.yaml → .github/workflows/release.yaml

@@ -1,16 +1,10 @@
-name: CD Pipeline
-run-name: CD 📦🚀
+name: Release Pipeline
+run-name: Release 📦🚀
 
 on:
-  workflow_run:
-    workflows: ["CI Pipeline"]
-    types: [completed]
+  workflow_dispatch:
     branches:
       - "main"
-    paths:
-      - "src/**"
-      - "requirements.txt"
-      - "LICENSE"
 
 jobs:
   CD:
@@ -27,6 +21,29 @@ jobs:
         uses: jetpack-io/[email protected]
       - name: Install all dependencies 📦
         run: devbox run install
+      - name: Tag Name
+        run: export TAG_NAME="0.1.$(date +%s)" && echo "🏷️ Tag name is $TAG_NAME"
+      - name: Create Tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'refs/tags/$TAG_NAME',
+              sha: context.sha
+            })
+      - name: Create Release
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.repos.createRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              tag_name: '$TAG_NAME',
+              name: 'Release $TAG_NAME',
+              generate_release_notes: true
+            })
       - name: 📦 Package
         run: devbox run build
       - name: 🚀 Publish to PyPI

src/yaml_to_markdown/convert.py

@@ -50,21 +50,26 @@ def main(
     json_file: Optional[str],
     show_help: bool,
 ) -> None:
-    if show_help or (yaml_file is None and json_file is None) or output_file is None:
+    if show_help:
         _help()
         return
+    _verify_inputs(output_file=output_file, yaml_file=yaml_file, json_file=json_file)
 
     convert(output_file=output_file, yaml_file=yaml_file, json_file=json_file)
 
 
+def _verify_inputs(
+    output_file: str, yaml_file: Optional[str], json_file: Optional[str]
+) -> None:
+    if (yaml_file is None and json_file is None) or output_file is None:
+        _help()
+        exit(1)
+
+
 def convert(
     output_file: str, yaml_file: Optional[str] = None, json_file: Optional[str] = None
 ) -> None:
-    if yaml_file is None and json_file is None or output_file is None:
-        _help()
-        raise RuntimeError(
-            "One of yaml_file or json_file is required along with output_file"
-        )
+    _verify_inputs(output_file=output_file, yaml_file=yaml_file, json_file=json_file)
 
     data = _get_json_data(json_file) if json_file else _get_yaml_data(yaml_file)
     with io.open(output_file, "w", encoding="utf-8") as md_file:

src/yaml_to_markdown/convert_test.py

@@ -11,9 +11,7 @@
 
 def test_convert_with_no_file() -> None:
     # Execute
-    with pytest.raises(
-        RuntimeError, match="One of yaml_file or json_file is required."
-    ):
+    with pytest.raises(SystemExit):
         convert(output_file="some.md")
 
 

src/yaml_to_markdown/md_converter.py

@@ -30,7 +30,7 @@ def set_custom_section_processors(
         custom_processors: Dict[
             str, Callable[[MDConverter, Optional[str], Any, int], str]
         ],
-    ):
+    ) -> None:
         """
         Set custom section processors, the key must match a section name/key
         and the processor must take 4 arguments and return a Markdown string:

src/yaml_to_markdown/utils_test.py

@@ -2,5 +2,5 @@
 
 
 class TestUtils:
-    def test_convert_to_title_case(self):
+    def test_convert_to_title_case(self) -> None:
         assert convert_to_title_case("test-case") == "Test Case"