Simpler regex and pandoc example and tests (#3)

Author: davegaeddert

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: test
+on:
+  push: {}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - run: pip install poetry
+    - run: poetry install
+    - run: ./scripts/test

README.md

@@ -41,3 +41,39 @@ jobs:
 $ pip install changerelease
 $ changerelease sync --repo org/repo --token TOKEN
 ```
+
+## What if my changelog isn't in Markdown?
+
+For changelogs written in reStructuredText or another syntax besides Markdown,
+you can run a conversion step before running changerelease.
+This can be a custom rendering script or something like [pandoc](https://pandoc.org/) to convert your changelog to Markdown.
+The only real expectation is that your version names are written in h2 headings (`## {version_name}`).
+
+```yaml
+name: changerelease
+on:
+  workflow_dispatch: {}
+  push:
+    paths: [CHANGELOG.md]
+    branches: [master]
+    tags: ["*"]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    # Convert to markdown first
+    # https://github.com/pandoc/pandoc-action-example
+    - uses: docker://pandoc/core:2.9
+        with:
+          args: "CHANGELOG.rst -f rst -t markdown -o CR_CHANGELOG.md"
+
+    - uses: dropseed/changerelease@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        # optional
+        tag_prefix: v
+        changelog: CR_CHANGELOG.md
+```

changerelease/changelog.py

@@ -2,6 +2,11 @@
 
 
 SKIP_VERSIONS = ["Unreleased"]
+RE_VERSION_HEADING = r"## "
+RE_VERSION_NAME = r"\[?([^\[\]\s]+)\]?"
+RE_VERSION_CONTENTS = r"([\s\S]+?)"
+RE_LINK_DEFINITIONS = r"\[.+\]: "
+RE_VERSION_HEADING_LINE = f"^{RE_VERSION_HEADING}{RE_VERSION_NAME}.*$"
 
 
 class Changelog:
@@ -11,13 +16,13 @@ def __init__(self, path, contents):
         self.versions = self.parse_versions()
 
     def parse_versions(self):
-        version_names = re.findall("^## \[(.+)\].*$", self.contents, re.MULTILINE)
+        version_names = re.findall(RE_VERSION_HEADING_LINE, self.contents, re.MULTILINE)
         version_names = [x for x in version_names if x not in SKIP_VERSIONS]
         return version_names
 
     def parse_version_content(self, version):
         matches = re.findall(
-            f"^## \[{version}\].*$([\s\S]+?)^(## |\[.+\]: )",
+            f"^{RE_VERSION_HEADING}\[?{version}\]?.*${RE_VERSION_CONTENTS}^({RE_VERSION_HEADING}|{RE_LINK_DEFINITIONS})",
             self.contents,
             re.MULTILINE,
         )