Add push_release function for programmatic releases - fixes #1554

Author: jph00

nbdev/_modidx.py

@@ -309,6 +309,7 @@
                                'nbdev.release.conda_output_path': ('api/release.html#conda_output_path', 'nbdev/release.py'),
                                'nbdev.release.latest_pypi': ('api/release.html#latest_pypi', 'nbdev/release.py'),
                                'nbdev.release.nbdev_bump_version': ('api/release.html#nbdev_bump_version', 'nbdev/release.py'),
+                               'nbdev.release.push_release': ('api/release.html#push_release', 'nbdev/release.py'),
                                'nbdev.release.pypi_details': ('api/release.html#pypi_details', 'nbdev/release.py'),
                                'nbdev.release.pypi_json': ('api/release.html#pypi_json', 'nbdev/release.py'),
                                'nbdev.release.release_both': ('api/release.html#release_both', 'nbdev/release.py'),

nbdev/release.py

@@ -3,9 +3,10 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/18_release.ipynb.
 
 # %% auto #0
-__all__ = ['GH_HOST', 'CONDA_WARNING', 'Release', 'changelog', 'release_git', 'release_gh', 'pypi_json', 'latest_pypi',
-           'pypi_details', 'conda_output_path', 'write_conda_meta', 'write_requirements', 'anaconda_upload',
-           'release_conda', 'chk_conda_rel', 'release_pypi', 'release_both', 'bump_version', 'nbdev_bump_version']
+__all__ = ['GH_HOST', 'CONDA_WARNING', 'Release', 'changelog', 'push_release', 'release_git', 'release_gh', 'pypi_json',
+           'latest_pypi', 'pypi_details', 'conda_output_path', 'write_conda_meta', 'write_requirements',
+           'anaconda_upload', 'release_conda', 'chk_conda_rel', 'release_pypi', 'release_both', 'bump_version',
+           'nbdev_bump_version']
 
 # %% ../nbs/api/18_release.ipynb #c35cc2b8
 from fastcore.all import *
@@ -114,16 +115,18 @@ def changelog(
     res = Release(repo=repo).changelog(debug=debug)
     if debug: print(res)
 
+# %% ../nbs/api/18_release.ipynb #15b66643
+def push_release(token:str=None):
+    "Create a GitHub release (changelog should already be committed/pushed). Returns the release."
+    return Release(token=token).release()
+
 # %% ../nbs/api/18_release.ipynb #6d3c5cd8
 @call_parse
-def release_git(
-    token:str=None  # Optional GitHub token (otherwise `token` file is used)
-):
+def release_git(token:str=None):
     "Tag and create a release in GitHub for the current version"
-    ver = Release(token=token).release()
-    print(f"Released {ver}")
+    print(f"Released {push_release(token)}")
 
-# %% ../nbs/api/18_release.ipynb #ad73518a
+# %% ../nbs/api/18_release.ipynb #94ee72b1
 @call_parse
 def release_gh(
     token:str=None  # Optional GitHub token (otherwise `token` file is used)
@@ -135,8 +138,7 @@ def release_gh(
     if not input("Make release now? (y/n) ").lower().startswith('y'): sys.exit(1)
     run('git commit -am release')
     run('git push')
-    ver = Release(token=token).release()
-    print(f"Released {ver}")
+    print(f"Released {push_release(token)}")
 
 # %% ../nbs/api/18_release.ipynb #5b4d4aa2
 from fastcore.all import *

nbs/api/18_release.ipynb

@@ -412,6 +412,19 @@
     "    if debug: print(res)"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "15b66643",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| export\n",
+    "def push_release(token:str=None):\n",
+    "    \"Create a GitHub release (changelog should already be committed/pushed). Returns the release.\"\n",
+    "    return Release(token=token).release()"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -421,18 +434,15 @@
    "source": [
     "#| export\n",
     "@call_parse\n",
-    "def release_git(\n",
-    "    token:str=None  # Optional GitHub token (otherwise `token` file is used)\n",
-    "):\n",
+    "def release_git(token:str=None):\n",
     "    \"Tag and create a release in GitHub for the current version\"\n",
-    "    ver = Release(token=token).release()\n",
-    "    print(f\"Released {ver}\")"
+    "    print(f\"Released {push_release(token)}\")"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "ad73518a",
+   "id": "94ee72b1",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -448,8 +458,7 @@
     "    if not input(\"Make release now? (y/n) \").lower().startswith('y'): sys.exit(1)\n",
     "    run('git commit -am release')\n",
     "    run('git push')\n",
-    "    ver = Release(token=token).release()\n",
-    "    print(f\"Released {ver}\")"
+    "    print(f\"Released {push_release(token)}\")"
    ]
   },
   {
@@ -931,13 +940,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "python3",
-   "language": "python",
-   "name": "python3"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
 }