Add a utility to get the latest draft release for a given repo (#301)

Author: blink1073

jupyter_releaser/tests/test_functions.py

@@ -6,6 +6,7 @@
 from pathlib import Path
 
 import toml
+from ghapi.core import GhApi
 
 from jupyter_releaser import changelog, npm, util
 from jupyter_releaser.tests import util as testutil
@@ -321,3 +322,11 @@ def test_get_config_npm(npm_package):
 def test_get_config_file(git_repo):
     config = util.read_config()
     assert "before-build-python" in config["hooks"]["before-build-python"]
+
+
+def test_get_latest_draft_release(mocker, open_mock):
+    open_mock.side_effect = [testutil.MockHTTPResponse([testutil.REPO_DATA, testutil.REPO_DATA_2])]
+    gh = GhApi()
+    latest = util.lastest_draft_release(gh)
+    assert latest.name == testutil.REPO_DATA_2["name"]
+    assert len(open_mock.call_args) == 2

jupyter_releaser/tests/util.py

@@ -176,6 +176,15 @@ def tbump_py_template(package_name="foo"):
     draft=True,
     created_at="2013-02-27T19:35:32Z",
 )
+REPO_DATA_2 = dict(
+    body="bar",
+    tag_name=f"v{VERSION_SPEC}",
+    target_commitish="bar",
+    name="foo2",
+    prerelease=False,
+    draft=True,
+    created_at="2013-02-27T20:35:32Z",
+)
 
 
 def mock_changelog_entry(package_path, runner, mocker, version_spec=VERSION_SPEC):

jupyter_releaser/util.py

@@ -13,6 +13,7 @@
 import tempfile
 import time
 import warnings
+from datetime import datetime
 from glob import glob
 from pathlib import Path
 from subprocess import PIPE, CalledProcessError, check_output
@@ -320,6 +321,23 @@ def release_for_url(gh, url):
     return release
 
 
+def lastest_draft_release(gh):
+    """Get the latest draft release for a given repo"""
+    newest_time = None
+    newest_release = None
+    for release in gh.repos.list_releases():
+        if str(release.draft).lower() == "false":
+            continue
+        created = release.created_at
+        d_created = datetime.strptime(created, r"%Y-%m-%dT%H:%M:%SZ")
+        if newest_time is None or d_created > newest_time:
+            newest_time = d_created
+            newest_release = release
+    if not newest_release:
+        raise ValueError("No draft releases found")
+    return newest_release
+
+
 def actions_output(name, value):
     "Print the special GitHub Actions `::set-output` line for `name::value`"
     log(f"\n\nSetting output {name}={value}")