bump: version 0.2.0a34 → 0.2.0a35

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.2.0a35 (2025-10-27)
+
+### Feat
+
+- tags documentation
+
+### Fix
+
+- add changelog support for github/gitlab format
+- tests
+
 ## 0.2.0a34 (2025-10-22)
 
 ### Feat

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
 
 [project]
 name = "rougail.output_doc"
-version = "0.2.0a34"
+version = "0.2.0a35"
 authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
 readme = "README.md"
 description = "Rougail output doc"

src/rougail/output_doc/__version__.py

@@ -1 +1 @@
-__version__ = "0.2.0a34"
+__version__ = "0.2.0a35"

src/rougail/output_doc/output/github.py

@@ -65,6 +65,20 @@ class Formater(CommonFormater):
         """Set a text to italic"""
         return f"*{msg}*"
 
+    def delete(
+        self,
+        msg: str,
+    ) -> str:
+        """Set a text to deleted"""
+        return f"~~{msg}~~"
+
+    def underline(
+        self,
+        msg: str,
+    ) -> str:
+        """Set a text to underline"""
+        return f"<ins>{msg}</ins>"
+
     def stripped(
         self,
         text: str,

tests/test_changelog.py

@@ -9,6 +9,8 @@ os.environ['COLUMNS'] = '80'
 test_ok = sorted(list((Path(__file__).parent / 'changelog').iterdir()))
 # test_ok = [Path(__file__).parent / 'changelog' / '40_dynamic_mod_default1']
 
+EXT = {'github': 'md', 'asciidoc': 'adoc', 'json': 'json', 'console': 'sh', 'gitlab': 'gitlab.md', "html": "html"}
+
 def idfn(fixture_value):
     return fixture_value.name
 
@@ -34,30 +36,21 @@ def test_changelog(test_dir):
     rougailconfig['main_namespace'] = None
     rougailconfig["step.output"] = "doc"
     rougailconfig['main_structural_directories'] = [str(test_dir / "after" / "rougail" / "00-base.yml")]
-    rougailconfig["doc.output_format"] = "asciidoc"
     rougailconfig["doc.contents"] = ["changelog"]
     rougailconfig["doc.previous_json_file"] = str(destfile)
     eolobj = Rougail(rougailconfig=rougailconfig)
     config = eolobj.run()
-    result = RougailOutputDoc(config, rougailconfig=rougailconfig).run()[1]
-    output_file = test_dir / 'result.adoc'
-    if not output_file.is_file():
-        with output_file.open('w') as outfh:
-            outfh.write(result)
-    with output_file.open() as outfh:
-         attented_output = outfh.read()
-    assert result == attented_output, f'filename {output_file}'
-    #
-    rougailconfig["doc.output_format"] = "console"
-#    eolobj = Rougail(rougailconfig=rougailconfig)
-#    config = eolobj.run()
-    result = RougailOutputDoc(config, rougailconfig=rougailconfig).run()[1]
-    output_file = test_dir / 'result.sh'
-    if not output_file.is_file():
-        with output_file.open('w') as outfh:
-            outfh.write(result)
-    with output_file.open() as outfh:
-         attented_output = outfh.read()
-    assert result == attented_output, f'filename {output_file}'
+    for output_format, ext in EXT.items():
+        if output_format == 'json':
+            continue
+        rougailconfig["doc.output_format"] = output_format
+        result = RougailOutputDoc(config, rougailconfig=rougailconfig).run()[1]
+        output_file = test_dir / f'result.{ext}'
+        if not output_file.is_file():
+            with output_file.open('w') as outfh:
+                outfh.write(result)
+        with output_file.open() as outfh:
+             attented_output = outfh.read()
+        assert result == attented_output, f'filename {output_file}'
     #
     destfile.unlink()