diff --git a/README.md b/README.md index 2cd3a8b..e939ceb 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,12 @@ https://github.com/spack/spack hpc,package-management https://github.com/singularityhub/sregistry containers,singularity ``` +### `label` + +**optional** By default, the repository will filter down to issues labeled with "good first issue". +However, you can change this by setting this variable to something else. + + ## Example usage ```yaml @@ -33,15 +39,26 @@ https://github.com/singularityhub/sregistry containers,singularity - name: Checkout Code uses: actions/checkout@v2 - name: Generate First Issues - uses: rseng/good-first-issues@v1.0.1 + uses: rseng/good-first-issues@v1.0.2 with: repos-file: '.github/repos.txt' token: ${{ secrets.GITHUB_TOKEN }} ``` You only need to define repos-file if you change the path (note that the above is changed from .github/repos.txt). It's -highly recommended that you don't use master branch, but instead -a version release or commit (as shown above). +highly recommended that you don't use master branch, but instead a version release or commit (as shown above). +Here is how you might update the label used: + +```yaml + steps: + - name: Checkout Code + uses: actions/checkout@v2 + - name: Generate First Issues + uses: rseng/good-first-issues@v1.0.2 + with: + label: 'bug' + token: ${{ secrets.GITHUB_TOKEN }} +``` ## Examples diff --git a/action.yml b/action.yml index db30005..1880ead 100644 --- a/action.yml +++ b/action.yml @@ -9,6 +9,10 @@ inputs: description: 'The relative path in the repository for the repos.txt' required: true default: 'repos.txt' + label: + description: 'The label to generate an interface for' + required: true + default: 'good first issue' token: description: > Auth token used to fetch the repository. @@ -19,3 +23,4 @@ runs: env: REPOS_FILE: ${{ inputs.repos-file }} GITHUB_TOKEN: ${{ inputs.token }} + ISSUE_LABEL: ${{ inputs.label }} diff --git a/scripts/generate-first-issues.py b/scripts/generate-first-issues.py index 03b3caa..63cce60 100755 --- a/scripts/generate-first-issues.py +++ b/scripts/generate-first-issues.py @@ -10,6 +10,7 @@ # GitHub Workflow - we get variables from environment REPOS_FILE = os.environ.get("REPOS_FILE") +ISSUE_LABEL = os.environ.get("ISSUE_LABEL", "good first issue") if not REPOS_FILE: sys.exit(f"{REPOS_FILE} must be defined.") @@ -26,7 +27,7 @@ # Must authenticate headers = {"Authorization": f"token {token}"} -data = {"state": "open", "labels": "good first issue"} +data = {"state": "open", "labels": ISSUE_LABEL} # Documentation base is located at docs output_dir = "/github/workspace/docs/_issues" @@ -60,7 +61,7 @@ # Add labels as tags tags = set([x["name"] for x in issue["labels"]]) - tags.remove("good first issue") + tags.remove(ISSUE_LABEL) tags = list(tags) if extra_tags: