add release

Author: jph00

nbdev/release.py

@@ -0,0 +1,129 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/17_release.ipynb.
+
+# %% auto 0
+__all__ = ['GH_HOST', 'Release', 'changelog', 'release_git', 'release_gh']
+
+# %% ../nbs/17_release.ipynb 2
+from fastcore.all import *
+from ghapi.core import *
+
+from datetime import datetime
+from configparser import ConfigParser
+import shutil,subprocess
+
+# %% ../nbs/17_release.ipynb 4
+GH_HOST = "https://api.github.com"
+
+# %% ../nbs/17_release.ipynb 5
+def _find_config(cfg_name="settings.ini"):
+    cfg_path = Path().absolute()
+    while cfg_path != cfg_path.parent and not (cfg_path/cfg_name).exists(): cfg_path = cfg_path.parent
+    return Config(cfg_path, cfg_name)
+
+# %% ../nbs/17_release.ipynb 6
+def _issue_txt(issue):
+    res = '- {} ([#{}]({}))'.format(issue.title.strip(), issue.number, issue.html_url)
+    if hasattr(issue, 'pull_request'): res += ', thanks to [@{}]({})'.format(issue.user.login, issue.user.html_url)
+    res += '\n'
+    if not issue.body: return res
+    return res + f"  - {issue.body.strip()}\n"
+
+def _issues_txt(iss, label):
+    if not iss: return ''
+    res = f"### {label}\n\n"
+    return res + '\n'.join(map(_issue_txt, iss))
+
+def _load_json(cfg, k):
+    try: return json.loads(cfg[k])
+    except json.JSONDecodeError as e: raise Exception(f"Key: `{k}` in .ini file is not a valid JSON string: {e}")
+
+# %% ../nbs/17_release.ipynb 8
+class Release:
+    def __init__(self, owner=None, repo=None, token=None, **groups):
+        "Create CHANGELOG.md from GitHub issues"
+        self.cfg = _find_config()
+        self.changefile = self.cfg.config_path/'CHANGELOG.md'
+        if not groups:
+            default_groups=dict(breaking="Breaking Changes", enhancement="New Features", bug="Bugs Squashed")
+            groups=_load_json(self.cfg, 'label_groups') if 'label_groups' in self.cfg else default_groups
+        os.chdir(self.cfg.config_path)
+        owner,repo = owner or self.cfg.user, repo or self.cfg.lib_name
+        token = ifnone(token, os.getenv('FASTRELEASE_TOKEN',None))
+        if not token and Path('token').exists(): token = Path('token').read_text().strip()
+        if not token: raise Exception('Failed to find token')
+        self.gh = GhApi(owner, repo, token)
+        self.groups = groups
+
+    def _issues(self, label):
+        return self.gh.issues.list_for_repo(state='closed', sort='created', filter='all', since=self.commit_date, labels=label)
+    def _issue_groups(self): return parallel(self._issues, self.groups.keys(), progress=False)
+
+# %% ../nbs/17_release.ipynb 10
+@patch
+def changelog(self:Release,
+              debug=False): ## Just print the latest changes, instead of updating file
+    "Create the CHANGELOG.md file, or return the proposed text if `debug` is `True`"
+    if not self.changefile.exists(): self.changefile.write_text("# Release notes\n\n<!-- do not remove -->\n")
+    marker = '<!-- do not remove -->\n'
+    try: self.commit_date = self.gh.repos.get_latest_release().published_at
+    except HTTP404NotFoundError: self.commit_date = '2000-01-01T00:00:004Z'
+    res = f"\n## {self.cfg.version}\n"
+    issues = self._issue_groups()
+    res += '\n'.join(_issues_txt(*o) for o in zip(issues, self.groups.values()))
+    if debug: return res
+    res = self.changefile.read_text().replace(marker, marker+res+"\n")
+    shutil.copy(self.changefile, self.changefile.with_suffix(".bak"))
+    self.changefile.write_text(res)
+    run(f'git add {self.changefile}')
+
+# %% ../nbs/17_release.ipynb 12
+@patch
+def release(self:Release):
+    "Tag and create a release in GitHub for the current version"
+    ver = self.cfg.version
+    notes = self.latest_notes()
+    self.gh.create_release(ver, branch=self.cfg.branch, body=notes)
+    return ver
+
+# %% ../nbs/17_release.ipynb 14
+@patch
+def latest_notes(self:Release):
+    "Latest CHANGELOG entry"
+    if not self.changefile.exists(): return ''
+    its = re.split(r'^## ', self.changefile.read_text(), flags=re.MULTILINE)
+    if not len(its)>0: return ''
+    return '\n'.join(its[1].splitlines()[1:]).strip()
+
+# %% ../nbs/17_release.ipynb 17
+@call_parse
+def changelog(
+    debug:store_true=False,  # Print info to be added to CHANGELOG, instead of updating file
+    repo:str=None,  # repo to use instead of `lib_name` from `settings.ini`
+):
+    "Create a CHANGELOG.md file from closed and labeled GitHub issues"
+    res = Release(repo=repo).changelog(debug=debug)
+    if debug: print(res)
+
+# %% ../nbs/17_release.ipynb 18
+@call_parse
+def release_git(
+    token:str=None  # Optional GitHub token (otherwise `token` file is used)
+):
+    "Tag and create a release in GitHub for the current version"
+    ver = Release(token=token).release()
+    print(f"Released {ver}")
+
+# %% ../nbs/17_release.ipynb 19
+@call_parse
+def release_gh(
+    token:str=None  # Optional GitHub token (otherwise `token` file is used)
+):
+    "Calls `Release.changelog`, lets you edit the result, then pushes to git and calls `Release.release_git`"
+    cfg = _find_config()
+    Release().changelog()
+    subprocess.run([os.environ.get('EDITOR','nano'), cfg.config_path/'CHANGELOG.md'])
+    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}")