fix: don't include anchors in GitHub releases. #53

Author: Ned Batchelder

changelog.d/20220724_165745_nedbat.rst

@@ -0,0 +1,7 @@
+Fixed
+.....
+
+- Anchors in the changelog were being included in the previous sections when
+  creating GitHub releases.  This has been fixed, closing `issue 53`_.
+
+.. _issue 53: https://github.com/nedbat/scriv/issues/53

src/scriv/format_md.py

@@ -27,6 +27,9 @@ def parse_text(
                 if re.search(r"^\s*<!--.*-->$", line):
                     # A one-line comment, skip it.
                     continue
+                if re.search(r"""^<a id=(['"])[-.\w]+\1></a>$""", line):
+                    # An anchor, we don't need those.
+                    continue
                 if re.search(r"^\s*<!--", line):
                     in_comment = True
                     continue

src/scriv/format_rst.py

@@ -46,6 +46,12 @@ def _is_comment(self, line: str) -> bool:
         else:
             return False
 
+    def _is_anchor(self, line: str) -> bool:
+        """
+        Determine if a line is an anchor.
+        """
+        return bool(re.search(r"^.. _[-.\w]+:$", line))
+
     def parse_text(
         self, text: str
     ) -> SectionDict:  # noqa: D102 (inherited docstring)
@@ -66,6 +72,9 @@ def parse_text(
                 # Comment, do nothing.
                 continue
 
+            if self._is_anchor(line):
+                continue
+
             if self._is_underline(line):
                 if section_char is None or line[0] == section_char:
                     # Section underline. Previous line was the heading.

src/scriv/github.py

@@ -94,5 +94,7 @@ def update_release(
             See create_release for the accepted keys.
     """
     logger.info(f"Updating release {release_data['name']}")
-    resp = requests.patch(release["url"], json=release_data, headers=auth_headers())
+    resp = requests.patch(
+        release["url"], json=release_data, headers=auth_headers()
+    )
     check_ok(resp)

tests/test_format_md.py

@@ -151,6 +151,7 @@
             """\
             (prelude)
 
+            <a id='sect-one.1'></a>
             ## Section one
 
             ### subhead
@@ -161,6 +162,7 @@
 
             Also sub
 
+            <a id='sect-two.2'></a>
             ## Section two
 
             In section two.

tests/test_format_rst.py

@@ -131,12 +131,16 @@
         # RST syntax is intricate. We understand a subset of it.
         pytest.param(
             """\
+            .. _fixed.1:
+
             Fixed
             .....
             - This thing was fixed: `issue 42`_.
 
             .. _issue 42: https://github.com/thing/issue/42
 
+            .. _added:
+
             Added
             .....