Add remote-changelog option

Author: davegaeddert

CHANGELOG.md

@@ -12,6 +12,7 @@ Nothing right now.
 ## [1.3.0] - 2020-09-07
 
 - Added a `--limit` option to only sync recent versions by default in a GitHub Action
+- Added a `--remote-changelog` option so you don't have to have the CHANGELOG file (or cloned repo) to use changerelease
 
 ## [1.2.0] - 2020-09-06
 

action.yml

@@ -14,6 +14,9 @@ inputs:
   limit:
     description: 'Limit syncing to the latest X versions'
     default: 5
+  remote_changelog:
+    description: 'Get the CHANGELOG using the GitHub API (does not require a cloned repo)'
+    default: true
 runs:
   using: docker
   image: Dockerfile
@@ -22,4 +25,5 @@ runs:
     CR_TAG_PREFIX: ${{ inputs.tag_prefix }}
     CR_NO_TAG_PREFIX: ${{ inputs.tag_prefix == '' }}
     CR_LIMIT: ${{ inputs.limit }}
+    CR_REMOTE_CHANGELOG: ${{ inputs.remote_changelog }}
     GITHUB_TOKEN: ${{ inputs.github_token }}

changerelease/changelog.py

@@ -5,11 +5,9 @@
 
 
 class Changelog:
-    def __init__(self, path):
+    def __init__(self, path, contents):
         self.path = path
-        with open(self.path, "r") as f:
-            self.contents = f.read()
-
+        self.contents = contents
         self.versions = self.parse_versions()
 
     def parse_versions(self):

changerelease/cli.py

@@ -1,5 +1,6 @@
 import os
 import re
+import base64
 
 import requests
 import click
@@ -18,10 +19,10 @@ def cli():
 @click.option(
     "--changelog",
     default="CHANGELOG.md",
-    type=click.Path(exists=True, file_okay=True, dir_okay=False),
     show_default=True,
     envvar="CR_CHANGELOG",
 )
+@click.option("--remote-changelog", is_flag=True, envvar="CR_REMOTE_CHANGELOG")
 @click.option("--tag-prefix", default="v", show_default=True, envvar="CR_TAG_PREFIX")
 @click.option("--no-tag-prefix", default=False, is_flag=True, envvar="CR_NO_TAG_PREFIX")
 @click.option("--repo", envvar="GITHUB_REPOSITORY", required=True)
@@ -32,7 +33,9 @@ def cli():
 )
 @click.option("--limit", default=-1, envvar="CR_LIMIT")
 @click.option("--token", envvar="GITHUB_TOKEN", required=True)
-def sync(changelog, tag_prefix, no_tag_prefix, repo, api_url, limit, token):
+def sync(
+    changelog, remote_changelog, tag_prefix, no_tag_prefix, repo, api_url, limit, token
+):
     if no_tag_prefix:
         tag_prefix = ""
 
@@ -44,7 +47,18 @@ def sync(changelog, tag_prefix, no_tag_prefix, repo, api_url, limit, token):
         }
     )
 
-    cl = Changelog(changelog)
+    if remote_changelog:
+        click.echo(f"Fetching current {changelog} from the {repo} repo")
+        response = requests_session.get(f"/repos/{repo}/contents/{changelog}")
+        response.raise_for_status()
+        changelog_contents = base64.b64decode(response.json()["content"]).decode(
+            "utf-8"
+        )
+    else:
+        with open(changelog, "r") as f:
+            changelog_contents = f.read()
+
+    cl = Changelog(changelog, changelog_contents)
 
     outline = "-" * 80