Add limit option

Author: davegaeddert

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing right now.
 
+## [1.3.0] - 2020-09-07
+
+- Added a `--limit` option to only sync recent versions by default in a GitHub Action
+
 ## [1.2.0] - 2020-09-06
 
 - Allows changelog content for a version to be empty, while still creating a GitHub Release for the tag.

action.yml

@@ -11,12 +11,15 @@ inputs:
   github_token:
     description: "A GitHub token that can create and modify releases"
     required: true
+  limit:
+    description: 'Limit syncing to the latest X versions'
+    default: 5
 runs:
   using: docker
   image: Dockerfile
-  args:
-    - --changelog ${{ inputs.changelog }}
   env:
+    CR_CHANGELOG: ${{ inputs.changelog }}
     CR_TAG_PREFIX: ${{ inputs.tag_prefix }}
     CR_NO_TAG_PREFIX: ${{ inputs.tag_prefix == '' }}
+    CR_LIMIT: ${{ inputs.limit }}
     GITHUB_TOKEN: ${{ inputs.github_token }}

changerelease/cli.py

@@ -20,6 +20,7 @@ def cli():
     default="CHANGELOG.md",
     type=click.Path(exists=True, file_okay=True, dir_okay=False),
     show_default=True,
+    envvar="CR_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")
@@ -29,8 +30,9 @@ def cli():
     envvar="GITHUB_API_URL",
     default="https://api.github.com",
 )
+@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, token):
+def sync(changelog, tag_prefix, no_tag_prefix, repo, api_url, limit, token):
     if no_tag_prefix:
         tag_prefix = ""
 
@@ -48,7 +50,12 @@ def sync(changelog, tag_prefix, no_tag_prefix, repo, api_url, token):
 
     results = []
 
-    for version in cl.versions:
+    versions = cl.versions
+    if limit > -1:
+        click.echo(f"Limiting to {limit} of {len(versions)} versions")
+        versions = versions[:limit]
+
+    for version in versions:
         click.secho(f"\nSyncing version {version}", bold=True)
         version_contents = cl.parse_version_content(version)