customize args for decorator

Signed-off-by: vsoch <vsoch@users.noreply.github.com>

CHANGELOG.md

@@ -14,6 +14,11 @@ represented by the pull requests that fixed them. Critical items to know are:
 Versions correspond with GitHub releases that can be referenced with @ using actions.
 
 ## [master](https://github.com/vsoch/pull-request-action/tree/master) (master)
+  - bugfix of missing output values (1.0.23)
+  - bugfix of token handling if 401 error received (missing 401 case) (1.0.21)
+  - bugfix of writing to environment file (missing newline) (1.0.19)
+  - bugfix of missing from branch with scheduled run (1.0.16)
+  - forgot to add assignees (1.0.15)
   - output and environment variables for PR number and return codes (1.0.5)
   - added support for reviewer (individual and team) assignments (1.0.4)
   - added support for maintainer can modify and assignees (1.0.3)

README.md

@@ -22,13 +22,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.6
+        uses: vsoch/pull-request-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH_PREFIX: "update/"
           PULL_REQUEST_BRANCH: "master"
 ```
 
+**Important**: Make sure to use a stable [release](https://github.com/vsoch/pull-request-action/releases) instead of a branch for your workflow.
+
+
 ## Environment Variable Inputs
 
 Unlike standard actions, this action just uses variables from the environment.
@@ -36,6 +39,8 @@ Unlike standard actions, this action just uses variables from the environment.
 | Name | Description | Required | Default |
 |------|-------------|----------|---------|
 | BRANCH_PREFIX | the prefix to filter to. If the branch doesn't start with the prefix, it will be ignored | false | "" |
+| PULL_REQUEST_REPOSITORY | Choose another repository instead of default GITHUB_REPOSITORY for the PR  | false | |
+| PULL_REQUEST_TOKEN | [Personal Access Token(PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) only if you define a different repository with PULL_REQUEST_REPOSITORY | false | |
 | PULL_REQUEST_BRANCH | open pull request against this branch | false | master |
 | PULL_REQUEST_FROM_BRANCH | if a branch isn't found in your GitHub payload, use this branch | false | |
 | PULL_REQUEST_BODY | the body for the pull request | false | |
@@ -45,10 +50,10 @@ Unlike standard actions, this action just uses variables from the environment.
 | PULL_REQUEST_ASSIGNEES | A list (string with spaces) of users to assign | false | unset |
 | PULL_REQUEST_REVIEWERS | A list (string with spaces) of users to assign review | false | unset |
 | PULL_REQUEST_TEAM_REVIEWERS | A list (string with spaces) of teams to assign review | false | unset |
-| PASS_ON_ERROR | Instead of failing on an error response, pass | unset |
-| PASS_IF_EXISTS | Instead of failing if the pull request already exists, pass | unset |
-| PULL_REQUEST_UPDATE | If the pull request already exists, update it | unset |
-| PULL_REQUEST_STATE | If `PULL_REQUEST_UPDATE` is true, update to this state (open, closed) | open |
+| PASS_ON_ERROR | Instead of failing on an error response, pass | false | unset |
+| PASS_IF_EXISTS | Instead of failing if the pull request already exists, pass | false | unset |
+| PULL_REQUEST_UPDATE | If the pull request already exists, update it | false | unset |
+| PULL_REQUEST_STATE | If `PULL_REQUEST_UPDATE` is true, update to this state (open, closed) | false |open |
 
 For `PULL_REQUEST_DRAFT`, `PASS_ON_ERROR`, `PASS_IF_EXISTS`, and `MAINTAINER_CANT_MODIFY`, these are
 treated as environment booleans. If they are defined in the environment, they trigger the
@@ -68,6 +73,8 @@ an issue or PR, they are ignored otherwise.
 The `GITHUB_TOKEN` secret is required to interact and authenticate with the GitHub API to open
 the pull request. The example is [deployed here](https://github.com/vsoch/pull-request-action-example) with an example opened (and merged) [pull request here](https://github.com/vsoch/pull-request-action-example/pull/1) if needed.
 
+If you want to create a pull request to another repository, for example, a pull request to the upstream repository, you need to define PULL_REQUEST_REPOSITORY and PULL_REQUEST_TOKEN. The PULL_REQUEST_TOKEN is one [Personal Access Token(PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token), which can be save in the [encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
+
 ## Outputs
 
 The action sets a few useful output and environment variables. An output can
@@ -93,7 +100,9 @@ The screenshot below shows the example in action to interact with outputs in sev
 ## Examples
 
 Example workflows are provided in [examples](examples), and please contribute any
-examples that you might have to help other users! We will walk through a basic
+examples that you might have to help other users! You can get the same commit hashes
+and commented tags if you use the [action-updater](https://github.com/vsoch/action-updater)
+also maintained by @vsoch. We will walk through a basic
 example here for a niche case. Let's say that we are opening a pull request on the release event. This would mean
 that the payload's branch variable would be null. We would need to define `PULL_REQUEST_FROM`. How would
 we do that? We can [set environment variables](https://github.com/actions/toolkit/blob/main/docs/commands.md#environment-files) for next steps. Here is an example:
@@ -112,9 +121,9 @@ jobs:
         run: |
             # do custom parsing of your code / date to derive a branch from
             PR_BRANCH_FROM=release-v$(cat VERSION)
-            export "PULL_REQUEST_FROM_BRANCH=${PR_BRANCH_FROM}" >> $GITHUB_ENV
+            echo "PULL_REQUEST_FROM_BRANCH=${PR_BRANCH_FROM}" >> $GITHUB_ENV
       - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.6
+        uses: vsoch/pull-request-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PULL_REQUEST_BRANCH: "master"

examples/assignees-example.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.3
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
         PULL_REQUEST_ASSIGNEES: vsoch

examples/branch-from-environment.yml

@@ -1,16 +1,15 @@
 name: derive-branch-from-environment
 
 on:
-  schedule:
-    # Weekly
-    - cron: 0 0 * * 0
+  schedule: -
+    cron: 0 0 * * 0
 
 jobs:
   DoSomeUpdate:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout Repository
-      uses: actions/checkout@v1
+      uses: actions/checkout@v3
     - name: Install or Do Something to Change repository
       run: |
         echo "This is a new file." >> newfile.txt
@@ -18,7 +17,7 @@ jobs:
     - name: Checkout New Branch
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        BRANCH_AGAINST: "master"
+        BRANCH_AGAINST: master
       run: |
         printf "GitHub Actor: ${GITHUB_ACTOR}\n"
         export BRANCH_FROM="update/newfile-$(date '+%Y-%m-%d')"
@@ -43,7 +42,7 @@ jobs:
         echo "PULL_REQUEST_FROM_BRANCH=${BRANCH_FROM}" >> $GITHUB_ENV
 
     - name: Open Pull Request
-      uses: vsoch/pull-request-action@1.0.6
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PULL_REQUEST_BRANCH: "master"
+        PULL_REQUEST_BRANCH: master

examples/custom-body-example.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Generate branch name
-        uses: actions/github-script@v3
+      uses: actions/github-script@v6
       id: set-branch-name
       with:
         script: |
@@ -34,7 +34,7 @@ jobs:
     - name: Set branch name
       run: echo "PULL_REQUEST_TITLE=${{steps.set-branch-name.outputs.result}}" >> $GITHUB_ENV
     - name: Generate PR body
-        uses: actions/github-script@v3
+      uses: actions/github-script@v6
       id: set-pr-body
       with:
         script: |
@@ -47,9 +47,9 @@ jobs:
     - name: Set PR body
       run: echo "PULL_REQUEST_BODY=${{steps.set-pr-body.outputs.result}}" >> $GITHUB_ENV
     - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.10
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "hotfix-"
-          PULL_REQUEST_BRANCH: "production"
-          PULL_REQUEST_REVIEWERS: "AnandChowdhary"
+        BRANCH_PREFIX: hotfix-
+        PULL_REQUEST_BRANCH: production
+        PULL_REQUEST_REVIEWERS: AnandChowdhary

examples/outputs-example.yml

@@ -10,11 +10,11 @@ jobs:
     steps:
     - name: pull-request-action
       id: pull_request
-        uses: vsoch/pull-request-action@1.0.6
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
         PULL_REQUEST_REVIEWERS: vsoch
     - name: Test outputs
       env:

examples/push-example.yml

@@ -11,8 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: pull-request-action
-        uses: vsoch/pull-request-action@add/support-null-branch
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master

examples/release-example.yml

@@ -18,31 +18,27 @@ jobs:
         version=$(echo "$tag_name" | sed 's/^v//')
         echo "Version: $version"
 
-        echo "::set-output name=suite_version::${version}"
-        echo "::set-output name=suite_update_branch::suite_${version}"
+        echo "suite_version=${version}" >> $GITHUB_OUTPUT
+        echo "suite_update_branch=suite_${version}" >> $GITHUB_OUTPUT
       id: data
 
     - name: Permanently save the new suite release
       run: |
         mkdir -p releases
-
         new_suite_version_yml="releases/suite_${{ steps.data.outputs.suite_version }}.yml"
         echo "Suite target file: $new_suite_version_yml"
-
         cp suite.yml "${new_suite_version_yml}"
-
         git add "${new_suite_version_yml}"
         git commit -m "Suite v${{ steps.data.outputs.suite_version }} auto-commit of new release files"
 
     - name: Push files
-      run: |
-        git push --force "https://${{ github.actor }}:${{secrets.GITHUB_TOKEN}}@github.com/${{ github.repository }}.git" "HEAD:${{ steps.data.outputs.suite_update_branch }}"
+      run: git push --force "https://${{ github.actor }}:${{secrets.GITHUB_TOKEN}}@github.com/${{ github.repository }}.git" "HEAD:${{ steps.data.outputs.suite_update_branch }}"
 
     - name: Open a PR to the default branch
-      uses: vsoch/pull-request-action@1.0.2
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PULL_REQUEST_FROM_BRANCH: "${{ steps.data.outputs.suite_update_branch }}"
+        PULL_REQUEST_FROM_BRANCH: ${{ steps.data.outputs.suite_update_branch }}
         PULL_REQUEST_BRANCH: master
-        PULL_REQUEST_TITLE: "Action: Update suite release file for v${{ steps.data.outputs.suite_version }}"
-        PULL_REQUEST_BODY: "Auto-generated PR!"
+        PULL_REQUEST_TITLE: 'Action: Update suite release file for v${{ steps.data.outputs.suite_version }}'
+        PULL_REQUEST_BODY: Auto-generated PR!

examples/reviewers-example.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.4
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
         PULL_REQUEST_REVIEWERS: vsoch

pull-request.py

@@ -1,9 +1,10 @@
 #!/usr/bin/env python3
 
-import sys
-import os
 import json
+import os
 import requests
+import sys
+import time
 
 ################################################################################
 # Helper Functions
@@ -35,6 +36,28 @@ def check_events_json():
     return events
 
 
+def retry(attempts=5, timeout=30):
+    """
+    A simple retry decorator
+
+    We assume rate limiting is in minutes, so we set timeout to 30.
+    """
+    def decorator(func):
+        def inner(*args, **kwargs):
+            attempt = 0
+            while attempt < attempts:
+                try:
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    sleep = timeout * 2**attempt
+                    print(f"Retrying in {sleep} seconds - error: {e}")
+                    time.sleep(sleep)
+                    attempt += 1
+            return func(*args, **kwargs)
+        return inner
+    return decorator
+
+
 def abort_if_fail(response, reason):
     """If PASS_ON_ERROR, don't exit. Otherwise exit with an error and print
     the reason.
@@ -57,7 +80,8 @@ def abort_if_fail(response, reason):
 
 
 def parse_into_list(values):
-    """A list of reviewers or assignees to parse from a string to a list
+    """
+    A list of reviewers or assignees to parse from a string to a list
 
     Parameters:
     values (str) : a list of space separated, quoted values to parse to a list
@@ -69,21 +93,26 @@ def parse_into_list(values):
     return [x.strip() for x in values.split(" ")]
 
 
-def set_env(name, value):
-    """helper function to echo a key/value pair to the environement file
+def set_env_and_output(name, value):
+    """
+    Helper function to echo a key/value pair to the environement file
 
     Parameters:
     name (str)  : the name of the environment variable
     value (str) : the value to write to file
     """
-    environment_file_path = os.environ.get("GITHUB_ENV")
+    for env_var in ("GITHUB_ENV", "GITHUB_OUTPUT"):
+        environment_file_path = os.environ.get(env_var)
+        print("Writing %s=%s to %s" % (name, value, env_var))
 
         with open(environment_file_path, "a") as environment_file:
-        environment_file.write("%s=%s" % (name, value))
+            environment_file.write("%s=%s\n" % (name, value))
 
 
+@retry(attempts=5, timeout=60)
 def open_pull_request(title, body, target, source, is_draft=False, can_modify=True):
-    """Open pull request opens a pull request with a given body and content,
+    """
+    Open pull request opens a pull request with a given body and content,
     and sets output variables. An unparsed response is returned.
 
     Parameters:
@@ -108,13 +137,16 @@ def open_pull_request(title, body, target, source, is_draft=False, can_modify=Tr
     print("Data for opening pull request: %s" % data)
     response = requests.post(PULLS_URL, json=data, headers=HEADERS)
     if response.status_code != 201:
+        print(f"pull request url is {PULLS_URL}")
         abort_if_fail(response, "Unable to create pull request")
 
     return response
 
 
+@retry()
 def update_pull_request(entry, title, body, target, state=None):
-    """Given an existing pull request, update it.
+    """
+    Given an existing pull request, update it.
 
     Parameters:
     entry      (dict) : the pull request metadata
@@ -142,7 +174,8 @@ def update_pull_request(entry, title, body, target, state=None):
 
 
 def set_pull_request_groups(response):
-    """Given a response for an open or updated PR, set metadata
+    """
+    Given a response for an open or updated PR, set metadata
 
     Parameters:
     response (requests.Response) : a requests response, unparsed
@@ -158,14 +191,12 @@ def set_pull_request_groups(response):
     number = response.get("number")
     html_url = response.get("html_url")
     print("Number opened for PR is %s" % number)
-    set_env("PULL_REQUEST_NUMBER", number)
-    print("::set-output name=pull_request_number::%s" % number)
-    set_env("PULL_REQUEST_RETURN_CODE", pull_request_return_code)
-    print("::set-output name=pull_request_return_code::%s" % pull_request_return_code)
-    set_env("PULL_REQUEST_URL", html_url)
-    print("::set-output name=pull_request_url::%s" % html_url)
+    set_env_and_output("PULL_REQUEST_NUMBER", number)
+    set_env_and_output("PULL_REQUEST_RETURN_CODE", pull_request_return_code)
+    set_env_and_output("PULL_REQUEST_URL", html_url)
 
 
+@retry(attempts=5, timeout=30)
 def list_pull_requests(target, source):
     """Given a target and source, return a list of pull requests that match
     (or simply exit given some kind of error code)
@@ -179,8 +210,8 @@ def list_pull_requests(target, source):
     print("Params for checking if pull request exists: %s" % params)
     response = requests.get(PULLS_URL, params=params)
 
-    # Case 1: 404 might warrant needing a token
-    if response.status_code == 404:
+    # Case 1: 401, 404 might warrant needing a token
+    if response.status_code in [401, 404]:
         response = requests.get(PULLS_URL, params=params, headers=HEADERS)
     if response.status_code != 200:
         abort_if_fail(response, "Unable to retrieve information about pull requests")
@@ -188,11 +219,14 @@ def list_pull_requests(target, source):
     return response.json()
 
 
-def add_assignees(entry):
-    """Given a pull request metadata (from create or update) add assignees
+@retry(attempts=5, timeout=30)
+def add_assignees(entry, assignees):
+    """
+    Given a pull request metadata (from create or update) add assignees
 
     Parameters:
     entry (dict)    : the pull request metadata
+    assignees (str) : comma separated assignees string set by action
     """
     # Remove leading and trailing quotes
     assignees = parse_into_list(assignees)
@@ -213,12 +247,12 @@ def add_assignees(entry):
     print("::group::github assignees response")
     print(response.json())
     print("::endgroup::github assignees response")
-    set_env("ASSIGNEES_RETURN_CODE", assignees_return_code)
-    print("::set-output name=assignees_return_code::%s" % assignees_return_code)
+    set_env_and_output("ASSIGNEES_RETURN_CODE", assignees_return_code)
 
 
 def find_pull_request(listing, source):
-    """Given a listing and a source, find a pull request based on the source
+    """
+    Given a listing and a source, find a pull request based on the source
     (the branch name).
 
     Parameters:
@@ -232,8 +266,28 @@ def find_pull_request(listing, source):
                 return entry
 
 
+@retry(attempts=5, timeout=30)
+def find_default_branch():
+    """
+    Find default branch for a repo (only called if branch not provided)
+    """
+    response = requests.get(REPO_URL)
+
+    # Case 1: 401, 404 might need a token
+    if response.status_code in [401, 404]:
+        response = requests.get(REPO_URL, headers=HEADERS)
+    if response.status_code != 200:
+        abort_if_fail(response, "Unable to retrieve default branch")
+
+    default_branch = response.json()["default_branch"]
+    print("Found default branch: %s" % default_branch)
+    return default_branch
+
+
+@retry(attempts=5, timeout=30)
 def add_reviewers(entry, reviewers, team_reviewers):
-    """Given regular or team reviewers, add them to a PR.
+    """
+    Given regular or team reviewers, add them to a PR.
 
     Parameters:
     entry (dict) : the pull request metadata
@@ -255,9 +309,7 @@ def add_reviewers(entry, reviewers, team_reviewers):
     print("::group::github reviewers response")
     print(response.json())
     print("::endgroup::github reviewers response")
-    set_env("REVIEWERS_RETURN_CODE", reviewers_return_code)
-    print("::set-output name=reviewers_return_code::%s" % reviewers_return_code)
-    print("Add reviewers return code: %s" % reviewers_return_code)
+    set_env_and_output("REVIEWERS_RETURN_CODE", reviewers_return_code)
 
 
 ################################################################################
@@ -265,16 +317,21 @@ def add_reviewers(entry, reviewers, team_reviewers):
 ################################################################################
 
 API_VERSION = "v3"
-BASE = "https://api.github.com"
+
+# Allow for a GitHub enterprise URL
+BASE = os.environ.get("GITHUB_API_URL") or "https://api.github.com"
+
+PR_TOKEN = os.environ.get("PULL_REQUEST_TOKEN") or get_envar("GITHUB_TOKEN")
+PR_REPO = os.environ.get("PULL_REQUEST_REPOSITORY") or get_envar("GITHUB_REPOSITORY")
 
 HEADERS = {
-    "Authorization": "token %s" % get_envar("GITHUB_TOKEN"),
+    "Authorization": "token %s" % PR_TOKEN,
     "Accept": "application/vnd.github.%s+json;application/vnd.github.antiope-preview+json;application/vnd.github.shadow-cat-preview+json"
     % API_VERSION,
 }
 
 # URLs
-REPO_URL = "%s/repos/%s" % (BASE, get_envar("GITHUB_REPOSITORY"))
+REPO_URL = "%s/repos/%s" % (BASE, PR_REPO)
 ISSUE_URL = "%s/issues" % REPO_URL
 PULLS_URL = "%s/pulls" % REPO_URL
 
@@ -320,7 +377,7 @@ def create_pull_request(
 
     # If we have opened or updated, we can add assignees
     if response and assignees:
-        add_assignees(response)
+        add_assignees(response, assignees)
     if response and (reviewers or team_reviewers):
         add_reviewers(response, reviewers, team_reviewers)
 
@@ -338,8 +395,11 @@ def main():
     if not branch_prefix:
         print("No branch prefix is set, all branches will be used.")
 
-    # Default to master to support older, will eventually change to main
-    pull_request_branch = os.environ.get("PULL_REQUEST_BRANCH", "master")
+    # Default to project default branch if none provided
+    pull_request_branch = os.environ.get("PULL_REQUEST_BRANCH")
+    if not pull_request_branch:
+        pull_request_branch = find_default_branch()
+
     print("Pull requests will go to %s" % pull_request_branch)
 
     # Pull request draft
@@ -393,7 +453,7 @@ def main():
     if not from_branch:
         print("PULL_REQUEST_FROM_BRANCH is not set, checking branch in payload.")
         with open(check_events_json(), "r") as fd:
-            from_branch = json.loads(fd.read()).get("ref")
+            from_branch = json.loads(fd.read()).get("ref", "")
         from_branch = from_branch.replace("refs/heads/", "").strip("/")
     else:
         print("PULL_REQUEST_FROM_BRANCH is set.")
@@ -413,7 +473,6 @@ def main():
 
     # If the prefix for the branch matches
     if not branch_prefix or from_branch.startswith(branch_prefix):
-
         # Pull request body (optional)
         pull_request_body = os.environ.get(
             "PULL_REQUEST_BODY",