Add ability to splice github release entry

Author: blink1073

jupyter_releaser/changelog.py

@@ -285,6 +285,40 @@ def check_entry(
         Path(output).write_text(final_entry, encoding="utf-8")
 
 
+def splice_github_entry(orig_entry, github_entry):
+    """Splice an entry created on GitHub into one created by build_entry"""
+
+    # Override PR titles
+    gh_regex = re.compile(r"^\* (.*?) by @.*?/pull/(\d+)$", flags=re.MULTILINE)
+    cl_regex = re.compile(r"^- (.*?) \[#(\d+)\]")
+
+    lut = {}
+    for title, pr in re.findall(gh_regex, github_entry):
+        lut[pr] = title
+
+    lines = orig_entry.splitlines()
+    for (ind, line) in enumerate(lines):
+        match = re.match(cl_regex, line)
+        if not match:
+            continue
+        title, pr = re.findall(cl_regex, line)[0]
+        if pr in lut:
+            lines[ind] = line.replace(title, lut[pr])
+
+    # Handle preamble
+    preamble_index = github_entry.index("## What's Changed")
+    if preamble_index > 0:
+        preamble = github_entry[:preamble_index]
+        if preamble.startswith("# "):
+            preamble = preamble.replace("# ", "## ")
+        if preamble.startswith("## "):
+            preamble = preamble.replace("## ", "### ")
+
+        lines = preamble.splitlines() + [""] + lines
+
+    return "\n".join(lines)
+
+
 def extract_current(changelog_path):
     """Extract the current changelog entry"""
     body = ""

jupyter_releaser/tests/test_functions.py

@@ -196,6 +196,29 @@ def test_get_empty_changelog(py_package, mocker):
     assert not ("...None" in resp)
 
 
+def test_splice_github_entry(py_package, mocker):
+    version = util.get_version()
+
+    mocked_gen = mocker.patch("jupyter_releaser.changelog.generate_activity_md")
+    mocked_gen.return_value = testutil.CHANGELOG_ENTRY
+    branch = "foo"
+    util.run("git branch baz/bar")
+    util.run("git tag v1.0.0 baz/bar")
+    util.run("git tag v1.1.0a0 baz/bar")
+    ref = "heads/baz/bar"
+    resp = changelog.get_version_entry(ref, branch, "baz/bar", version, since_last_stable=True)
+
+    updated = changelog.splice_github_entry(resp, testutil.GITHUB_CHANGELOG_ENTRY)
+
+    assert "Defining contributions" in updated
+
+    preamble = "# My title\nmy content\n"
+    updated = changelog.splice_github_entry(resp, preamble + testutil.GITHUB_CHANGELOG_ENTRY)
+
+    assert "Defining contributions" in updated
+    assert preamble in updated
+
+
 def test_compute_sha256(py_package):
     assert len(util.compute_sha256(py_package / "CHANGELOG.md")) == 64
 

jupyter_releaser/tests/util.py

@@ -53,6 +53,16 @@
 
 """
 
+GITHUB_CHANGELOG_ENTRY = """
+## What's Changed
+* Some improvements to `since` and opened issues list @choldgraf in https://github.com/executablebooks/github-activity/pull/8
+* Defining contributions by @choldgraf in https://github.com/executablebooks/github-activity/pull/14
+* Fixing link to changelog with refs by @choldgraf in https://github.com/executablebooks/github-activity/pull/11
+
+
+**Full Changelog**: https://github.com/executablebooks/github-activity/compare/479cc4b2f5504945021e3c4ee84818a10fabf810...ed7f1ed78b523c6b9fe6b3ac29e834087e299296
+"""
+
 
 def setup_cfg_template(package_name="foo", module_name=None):
     return f"""