Support hyperlinks for restructured text file format

changelog.rst

@@ -1,6 +1,14 @@
 Commit History
 ==============
 
+0.5.3 (11/30/2023)
+------------------
+- Support hyperlinks for restructured text file format
+
+0.5.2 (10/25/2023)
+------------------
+- Update release_notes.rst and cleanup
+
 0.5.1 (10/25/2023)
 ------------------
 - Reduce redundancy in looping through `git tag`
@@ -36,6 +44,7 @@ Commit History
 
 0.4.5 (08/30/2023)
 ------------------
+- Restructure version naming in output files
 - Set return type to None from NoReturn
 - Upgrade to latest flake8 and isort
 - Bump version

gitverse/__init__.py

@@ -1 +1 @@
-version = "2.9"
+version = "3.0"

gitverse/models/callables.py

@@ -1 +1,4 @@
-options = {'debug': False, 'reverse': False, 'start': 0.0}
+import re
+
+md_link_pattern = re.compile(r'\[([^\]]+)]\(([^)]+)\)')  # noqa
+options = {'debug': False, 'reverse': False, 'start': 0.0, 'ext': None}

gitverse/releases.py

@@ -12,7 +12,7 @@
 from gitverse import version as pkg_version
 from gitverse.models import debugger
 from gitverse.models.auth_bearer import BearerAuth
-from gitverse.models.callables import options
+from gitverse.models.callables import md_link_pattern, options
 
 
 def get_api_releases() -> Dict[str, List[str]]:
@@ -135,6 +135,8 @@ def generate_snippets() -> List[str]:
             line2 = "-" * len(line1)
             description = []
             for desc in each_tag['description']:
+                if options['ext'] == '.rst':
+                    desc = md_link_pattern.sub(r'`\1 <\2>`_', desc)
                 if desc.startswith('-'):
                     description.append(desc)
                 else:
@@ -209,11 +211,18 @@ def main(*args, reverse: str = None, debug: str = None,
         return
 
     if filename is None:
-        filename = 'ReleaseNotes'
+        filename = 'release_notes.md'
     if title is None:
         title = 'Release Notes'
     if env is None:
         env = '.env'
+
+    name, extension = os.path.splitext(filename.lower())
+    if name and extension in ('.rst', '.md'):
+        options['ext'] = extension
+    else:
+        debugger.info("Module generates the notes in markdown or restructured text format")
+        debugger.warning(f"Using {filename!r} may render unexpected format")
     kwargs = dict(dotenv_path=env, override=True, verbose=False)
     if options['debug']:
         kwargs['verbose'] = True

release_notes.rst

@@ -1,6 +1,10 @@
 Release Notes
 =============
 
+v3.0 (11/30/2023)
+-----------------
+- Support hyperlinks for restructured text file format
+
 v2.9 (10/25/2023)
 -----------------
 - Reduces redundancy and improves reliability