customize args for decorator

Signed-off-by: vsoch <vsoch@users.noreply.github.com>
add retry in case rate limit exceeded
2023-02-14 18:13:51 -07:00 · 2023-02-11 19:00:26 -07:00 · 2023-01-11 12:39:17 -07:00 · 2023-01-06 20:03:27 -07:00 · 2022-11-23 14:02:13 -07:00 · 2022-10-25 21:00:21 -06:00
10 changed files with 177 additions and 141 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,8 @@ 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)
--- a/README.md
+++ b/README.md
@@ -100,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:
@@ -119,7 +121,7 @@ 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@master
        env:
--- a/examples/assignees-example.yml
+++ b/examples/assignees-example.yml
@@ -9,9 +9,9 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      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
--- a/examples/branch-from-environment.yml
+++ b/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@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PULL_REQUEST_BRANCH: "master"
+        PULL_REQUEST_BRANCH: master
--- a/examples/custom-body-example.yml
+++ b/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@master
+      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
--- a/examples/outputs-example.yml
+++ b/examples/outputs-example.yml
@@ -10,11 +10,11 @@ jobs:
    steps:
    - name: pull-request-action
      id: pull_request
-        uses: vsoch/pull-request-action@master
+      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:
--- a/examples/push-example.yml
+++ b/examples/push-example.yml
@@ -11,8 +11,8 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      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
--- a/examples/release-example.yml
+++ b/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@master
+      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!
--- a/examples/reviewers-example.yml
+++ b/examples/reviewers-example.yml
@@ -9,9 +9,9 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      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
--- a/pull-request.py
+++ b/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\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:
@@ -114,8 +143,10 @@ def open_pull_request(title, body, target, source, is_draft=False, can_modify=Tr
    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
@@ -143,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
@@ -159,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)
@@ -180,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")
@@ -189,8 +219,10 @@ def list_pull_requests(target, source):
    return response.json()


+@retry(attempts=5, timeout=30)
 def add_assignees(entry, assignees):
-    """Given a pull request metadata (from create or update) add assignees
+    """
+    Given a pull request metadata (from create or update) add assignees

    Parameters:
    entry (dict)    : the pull request metadata
@@ -215,12 +247,12 @@ def add_assignees(entry, assignees):
    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:
@@ -234,12 +266,15 @@ 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)"""
+    """
+    Find default branch for a repo (only called if branch not provided)
+    """
    response = requests.get(REPO_URL)

-    # Case 1: 404 might need a token
-    if response.status_code == 404:
+    # 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")
@@ -249,8 +284,10 @@ def find_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
@@ -272,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)


 ################################################################################
@@ -361,7 +396,10 @@ def main():
        print("No branch prefix is set, all branches will be used.")

    # Default to project default branch if none provided
-    pull_request_branch = os.environ.get("PULL_REQUEST_BRANCH", find_default_branch())
+    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
@@ -435,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",
Author	SHA1	Message	Date
vsoch	89160a5742	customize args for decorator Signed-off-by: vsoch <vsoch@users.noreply.github.com>	2023-02-14 18:13:51 -07:00
vsoch	b57393d6ea	add retry in case rate limit exceeded Signed-off-by: vsoch <vsoch@users.noreply.github.com>	2023-02-11 19:00:26 -07:00
Vanessasaurus	f9e7f419d6	Merge pull request #94 from vsoch/check-for-branch Check for PR branch	2023-01-11 12:39:17 -07:00
Vanessasaurus	dcba08c9c2	Check for PR branch before using the API so we hopefully save a call.	2023-01-06 20:03:27 -07:00
Yoshihisa Mochihara	c8e84cea4c	fix GITHUB_OUTPUT bug (#92 ) * fix GITHUB_OUTPUT bug * Update CHANGELOG.md	2022-11-23 14:02:13 -07:00
Vanessasaurus	50f22f6d14	Update/set output (#90 ) * updating set-output to echo to $GITHUB_OUTPUT instead Signed-off-by: vsoch <vsoch@users.noreply.github.com>	2022-10-25 21:00:21 -06:00
Yunqi(Alice)	d703f40f3a	Update the list_pull_request 401 case (#89 ) * Update the list_pull_request 401 case Hi, I find this http request is also missing the 401 case. * Update CHANGELOG.md	2022-09-28 10:03:05 -06:00
Vanessasaurus	415544869c	Merge pull request #88 from ohenak/fix/ghe-get-401-error [Chore] Provide token when getting 401 error	2022-09-22 03:59:00 -06:00
Kane Ho	667293445b	[Chore] Provide token when getting 401 error Issue #87 In GHE, token is necessary when querying the repo API, When it fails, it returns 401 error. Will need to specify the token in this case.	2022-09-21 23:44:03 -07:00
Felix Breidenstein	e64deeba68	Fix example in README (#85 )	2022-03-18 08:44:13 -06:00