Add tag_prefix option

Author: davegaeddert

README.md

@@ -4,8 +4,6 @@ Sync your GitHub Release notes with your `CHANGELOG.md`.
 
 This tool expects that you follow the [Keep a Changelog](https://keepachangelog.com/) format.
 
-Note that, per [SemVer](https://semver.org/spec/v1.0.0.html#tagging-specification-semvertag), this tool also expects that your git tags are prefixed with a "v". As in, "v3.0.0" and not "3.0.0".
-
 ## Use the GitHub Action
 
 ```yml
@@ -25,6 +23,9 @@ jobs:
     - uses: dropseed/changerelease@v1
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
+        # optional
+        tag_prefix: v
+        changelog: CHANGELOG.md
 ```
 
 ## Use the Python package

action.yml

@@ -5,13 +5,16 @@ inputs:
     description: 'Path to your CHANGELOG'
     required: false
     default: 'CHANGELOG.md'
+  tag_prefix:
+    description: 'The prefix that is on SemVer tags (i.e. "v" or nothing "")'
+    default: 'v'
   github_token:
     description: "A GitHub token that can create and modify releases"
     required: true
 runs:
   using: docker
   image: Dockerfile
   args:
-    - --changelog ${{ inputs.changelog }}
+    - --changelog ${{ inputs.changelog }} --tag-prefix ${{ inputs.tag_prefix }}
   env:
     GITHUB_TOKEN: ${{ inputs.github_token }}

changerelease/cli.py

@@ -20,13 +20,14 @@ def cli():
     default="CHANGELOG.md",
     type=click.Path(exists=True, file_okay=True, dir_okay=False),
 )
+@click.option("--tag-prefix", default="v")
 @click.option("--repo", default=lambda: os.environ.get("GITHUB_REPOSITORY", ""))
 @click.option(
     "--api-url",
     default=lambda: os.environ.get("GITHUB_API_URL", "https://api.github.com"),
 )
 @click.option("--token", default=lambda: os.environ.get("GITHUB_TOKEN", ""))
-def sync(changelog, repo, api_url, token):
+def sync(changelog, tag_prefix, repo, api_url, token):
     requests_session = APISession(base_url=api_url)
     requests_session.headers.update(
         {
@@ -44,9 +45,10 @@ def sync(changelog, repo, api_url, token):
             click.secho(f"No content found for version {version}", fg="yellow")
             continue
 
-        release = Release(repo, version, requests_session)
+        release = Release(repo, tag_prefix, version, requests_session)
         release.sync(version_contents)
 
+    # TODO fail if tag doesn't exist yet? (continue w/ others though)
     click.secho(f"\nGitHub releases on {repo} synced with {cl.path}", fg="green")
 
 

changerelease/release.py

@@ -2,9 +2,11 @@
 
 
 class Release:
-    def __init__(self, repo, version, requests_session):
+    def __init__(self, repo, tag_prefix, version, requests_session):
         self.repo = repo
+        self.tag_prefix = tag_prefix
         self.version = version
+        self.version_tag = tag_prefix + version
 
         self.requests_session = requests_session
 
@@ -15,7 +17,7 @@ def exists(self):
 
     def tag_exists(self):
         response = self.requests_session.get(
-            f"/repos/{self.repo}/git/refs/tags/v{self.version}"
+            f"/repos/{self.repo}/git/refs/tags/{self.version_tag}"
         )
         if response.status_code == 404:
             return False
@@ -27,19 +29,19 @@ def body_matches(self, contents):
 
     def get(self):
         response = self.requests_session.get(
-            f"/repos/{self.repo}/releases/tags/v{self.version}"
+            f"/repos/{self.repo}/releases/tags/{self.version_tag}"
         )
         if response.status_code == 404:
             return {}
         response.raise_for_status()
         return response.json()
 
-    def create(self, name, contents):
+    def create(self, contents):
         response = self.requests_session.post(
             f"/repos/{self.repo}/releases",
             json={
-                "tag_name": "v" + name,
-                "name": name,
+                "tag_name": self.version_tag,
+                "name": self.version,
                 "body": contents,
                 # TODO prerelease if semver prerelease
             },
@@ -61,11 +63,11 @@ def sync(self, contents):
                     f"Release for {self.version} does not exist. Creating it...",
                     fg="green",
                 )
-                release_data = self.create(self.version, contents)
+                release_data = self.create(contents)
                 click.echo(release_data["html_url"])
             else:
                 click.secho(
-                    f'Git tag "v{self.version}" not found. A tag needs to be pushed before we can create a release for it.',
+                    f'Git tag "{self.version_tag}" not found. A tag needs to be pushed before we can create a release for it.',
                     fg="red",
                 )
         elif not self.body_matches(contents):