Merge branch 'multi-platform' into multi-platform-release

Update dependency GitPython to v3.0.4

.github/workflows/create-pull-request-multi.yml

@@ -1,7 +1,7 @@
+name: create-pull-request workflow
 on:
   repository_dispatch:
     types: [create-pull-request-multi]
-name: create-pull-request workflow
 jobs:
   createPullRequest:
     name: Testing on ${{ matrix.platform }}
@@ -25,9 +25,12 @@ jobs:
           COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
           COMMIT_AUTHOR_NAME: Peter Evans
           PULL_REQUEST_TITLE: '[Example] Add report file'
-          PULL_REQUEST_BODY: >
-            This PR is auto-generated by 
-            [create-pull-request](https://github.com/peter-evans/create-pull-request).
+          PULL_REQUEST_BODY: |
+            New report
+            - Contains *today's* date
+            - Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
           PULL_REQUEST_LABELS: report, automated pr
           PULL_REQUEST_ASSIGNEES: peter-evans
           PULL_REQUEST_REVIEWERS: peter-evans

.github/workflows/create-pull-request.yml

@@ -1,7 +1,7 @@
+name: create-pull-request workflow
 on:
   repository_dispatch:
     types: [create-pull-request]
-name: create-pull-request workflow
 jobs:
   createPullRequest:
     runs-on: ubuntu-latest
@@ -17,9 +17,12 @@ jobs:
           COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
           COMMIT_AUTHOR_NAME: Peter Evans
           PULL_REQUEST_TITLE: '[Example] Add report file'
-          PULL_REQUEST_BODY: >
-            This PR is auto-generated by 
-            [create-pull-request](https://github.com/peter-evans/create-pull-request).
+          PULL_REQUEST_BODY: |
+            New report
+            - Contains *today's* date
+            - Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
           PULL_REQUEST_LABELS: report, automated pr
           PULL_REQUEST_ASSIGNEES: peter-evans
           PULL_REQUEST_REVIEWERS: peter-evans

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.10.2
+FROM alpine:3.10.3
 
 LABEL maintainer="Peter Evans <mail@peterevans.dev>"
 LABEL repository="https://github.com/peter-evans/create-pull-request"

README.md

@@ -10,7 +10,7 @@ The changes will be automatically committed to a new branch and a pull request c
 Create Pull Request action will:
 
 1. Check for repository changes in the Actions workspace. This includes untracked (new) files as well as modified files.
-2. Commit all changes to a new branch, or update an existing pull request branch. The commit will be made using the name and email of the `HEAD` commit author.
+2. Commit all changes to a new branch, or update an existing pull request branch.
 3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
 
 ## Usage
@@ -18,7 +18,7 @@ Create Pull Request action will:
 Linux
 ```yml
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.0
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -26,7 +26,7 @@ Linux
 Multi platform - Linux, MacOS, Windows (beta)
 ```yml
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.0-multi
+        uses: peter-evans/create-pull-request@v1.5.4-multi
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -36,23 +36,30 @@ See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) f
 
 ### Environment variables
 
-These variables are all optional. If not set, a default value will be used.
+These variables are *all optional*. If not set, sensible default values will be used.
 
-- `COMMIT_MESSAGE` - The message to use when committing changes.
-- `PULL_REQUEST_TITLE` - The title of the pull request.
-- `PULL_REQUEST_BODY` - The body of the pull request.
-- `PULL_REQUEST_LABELS` - A comma separated list of labels.
-- `PULL_REQUEST_ASSIGNEES` - A comma separated list of assignees (GitHub usernames).
-- `PULL_REQUEST_REVIEWERS` - A comma separated list of reviewers (GitHub usernames) to request a review from.
-- `PULL_REQUEST_TEAM_REVIEWERS` - A comma separated list of GitHub teams to request a review from.
-- `PULL_REQUEST_MILESTONE` - The number of the milestone to associate this pull request with.
-- `PULL_REQUEST_BRANCH` - The branch name. See **Branch naming** below for details.
-- `BRANCH_SUFFIX` - The branch suffix type. Valid values are `short-commit-hash` (default), `timestamp`, `random` and `none`. See **Branch naming** below for details.
+| Name | Description | Default |
+| --- | --- | --- |
+| `COMMIT_MESSAGE` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` |
+| `COMMIT_AUTHOR_EMAIL` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>@users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. |
+| `COMMIT_AUTHOR_NAME` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>, the GitHub user that initiated the event. |
+| `PULL_REQUEST_TITLE` | The title of the pull request. | `Auto-generated by create-pull-request action` |
+| `PULL_REQUEST_BODY` | The body of the pull request. | `Auto-generated pull request by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action` |
+| `PULL_REQUEST_LABELS` | A comma separated list of labels. | none |
+| `PULL_REQUEST_ASSIGNEES` | A comma separated list of assignees (GitHub usernames). | none |
+| `PULL_REQUEST_REVIEWERS` | A comma separated list of reviewers (GitHub usernames) to request a review from. | none |
+| `PULL_REQUEST_TEAM_REVIEWERS` | A comma separated list of GitHub teams to request a review from. | none |
+| `PULL_REQUEST_MILESTONE` | The number of the milestone to associate this pull request with. | none |
+| `PULL_REQUEST_BRANCH` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` |
+| `PULL_REQUEST_BASE` | Overrides the base branch. **Use with caution!** | Defaults to the currently checked out branch. |
+| `BRANCH_SUFFIX` | The branch suffix type. Valid values are `short-commit-hash`, `timestamp`, `random` and `none`. See **Branch naming** below for details. | `short-commit-hash` |
 
-Output environment variables
+**Output environment variables**
 
 - `PULL_REQUEST_NUMBER` - The number of the pull request created.
 
+**Debug environment variables**
+
 The following parameters are available for debugging and troubleshooting.
 
 - `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow.
@@ -86,10 +93,10 @@ If there are files or directories you want to ignore you can simply add them to
 Here is an example that sets all the main environment variables.
 
 ```yml
+name: create-pull-request workflow
 on:
   repository_dispatch:
     types: [create-pull-request]
-name: create-pull-request workflow
 jobs:
   createPullRequest:
     runs-on: ubuntu-latest
@@ -98,14 +105,19 @@ jobs:
       - name: Create report file
         run: date +%s > report.txt
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.0
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_MESSAGE: Add report file
+          COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
+          COMMIT_AUTHOR_NAME: Peter Evans
           PULL_REQUEST_TITLE: '[Example] Add report file'
-          PULL_REQUEST_BODY: >
-            This PR is auto-generated by 
-            [create-pull-request](https://github.com/peter-evans/create-pull-request).
+          PULL_REQUEST_BODY: |
+            New report
+            - Contains *today's* date
+            - Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
           PULL_REQUEST_LABELS: report, automated pr
           PULL_REQUEST_ASSIGNEES: peter-evans
           PULL_REQUEST_REVIEWERS: peter-evans
@@ -120,6 +132,92 @@ This configuration will create pull requests that look like this:
 
 ![Pull Request Example](https://github.com/peter-evans/create-pull-request/blob/master/pull-request-example.png?raw=true)
 
+
+### Example workflow to automate periodic dependency updates
+
+This example workflow executes once a week and will create a pull request for any dependency updates. This pattern will work well for updating any kind of static content from an external source.
+
+```yml
+name: Update Dependencies
+on:
+  schedule:
+    - cron:  '0 10 * * 1'
+jobs:
+  update-deps:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
+      - name: Update dependencies
+        id: vars
+        run: |
+          npm install -g npm-check-updates
+          ncu -u
+          npm install
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1.5.4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MESSAGE: update dependencies
+          COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
+          COMMIT_AUTHOR_NAME: Peter Evans
+          PULL_REQUEST_TITLE: Automated Dependency Updates
+          PULL_REQUEST_BODY: This is an auto-generated PR with dependency updates.
+          PULL_REQUEST_LABELS: dep-updates, automated pr
+          PULL_REQUEST_REVIEWERS: peter-evans
+          PULL_REQUEST_BRANCH: dep-updates
+          BRANCH_SUFFIX: none
+```
+
+### Example usage with "on: pull_request" workflows
+
+The following is an example workflow for a use-case where [autopep8 action](https://github.com/peter-evans/autopep8) runs as both a check on pull requests and raises a further pull request to apply code fixes. This is a pattern that would work well for any automated code linting and fixing.
+
+How it works:
+
+1. When a pull request is raised the workflow executes as a check
+2. If autopep8 makes any fixes a pull request will be raised for those fixes to be merged into the current pull request branch. The workflow then deliberately causes the check to fail.
+3. When the pull request containing the fixes is merged the workflow runs again. This time autopep8 makes no changes and the check passes.
+4. The original pull request can now be merged.
+
+```yml
+name: autopep8
+on: pull_request
+jobs:
+  autopep8:
+    if: startsWith(github.head_ref, 'autopep8-patches') == false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: autopep8
+        id: autopep8
+        uses: peter-evans/autopep8@v1.1.0
+        with:
+          args: --exit-code --recursive --in-place --aggressive --aggressive .
+      - name: Set autopep8 branch name
+        id: vars
+        run: echo ::set-output name=branch-name::"autopep8-patches/$GITHUB_HEAD_REF"
+      - name: Create Pull Request
+        if: steps.autopep8.outputs.exit-code == 2
+        uses: peter-evans/create-pull-request@v1.5.4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MESSAGE: autopep8 action fixes
+          COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
+          COMMIT_AUTHOR_NAME: Peter Evans
+          PULL_REQUEST_TITLE: Fixes by autopep8 action
+          PULL_REQUEST_BODY: This is an auto-generated PR with fixes by autopep8.
+          PULL_REQUEST_LABELS: autopep8, automated pr
+          PULL_REQUEST_REVIEWERS: peter-evans
+          PULL_REQUEST_BRANCH: ${{ steps.vars.outputs.branch-name }}
+          BRANCH_SUFFIX: none
+      - name: Fail if autopep8 made changes
+        if: steps.autopep8.outputs.exit-code == 2
+        run: exit 1
+```
+
 ### Dynamic configuration using variables
 
 The following examples show how configuration for the action can be dynamically defined in a previous workflow step.
@@ -134,7 +232,7 @@ The recommended method is to use `set-output`. Note that the step where output v
           echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \
             by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.0
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }}
@@ -150,7 +248,7 @@ Since the action reads environment variables from the system, it's technically n
           echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \
             by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.0
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```

create-pull-request.py

@@ -19,24 +19,6 @@ def get_github_event(github_event_path):
     return github_event
 
 
-def ignore_event(event_name, event_data):
-    if event_name == "push":
-        # Ignore push events on deleted branches
-        # The event we want to ignore occurs when a PR is created but the repository owner decides
-        # not to commit the changes. They close the PR and delete the branch. This creates a 
-        # "push" event that we want to ignore, otherwise it will create another branch and PR on
-        # the same commit.
-        deleted = "{deleted}".format(**event_data)
-        if deleted == "True":
-            print("Ignoring delete branch event.")
-            return True
-        ref = "{ref}".format(**event_data)
-        if not ref.startswith('refs/heads/'):
-            print("Ignoring events for tags and remotes.")
-            return True
-    return False
-
-
 def get_head_short_sha1(repo):
     return repo.git.rev_parse('--short', 'HEAD')
 
@@ -68,7 +50,9 @@ def set_git_config(git, email, name):
 
 
 def set_git_remote_url(git, token, github_repository):
-    git.remote('set-url', 'origin', "https://x-access-token:%s@github.com/%s" % (token, github_repository))
+    git.remote(
+        'set-url', 'origin', "https://x-access-token:%s@github.com/%s" %
+        (token, github_repository))
 
 
 def checkout_branch(git, remote_exists, branch):
@@ -77,7 +61,7 @@ def checkout_branch(git, remote_exists, branch):
         git.checkout(branch)
         try:
             git.stash('pop')
-        except:
+        except BaseException:
             git.checkout('--theirs', '.')
             git.reset()
     else:
@@ -97,10 +81,7 @@ def cs_string_to_list(str):
     return list(filter(None, l))
 
 
-def process_event(event_name, event_data, repo, branch, base, remote_exists):
-    # Fetch required environment variables
-    github_token = os.environ['GITHUB_TOKEN']
-    github_repository = os.environ['GITHUB_REPOSITORY']
+def process_event(github_token, github_repository, repo, branch, base, remote_exists):
     # Fetch optional environment variables with default values
     commit_message = os.getenv(
         'COMMIT_MESSAGE',
@@ -118,15 +99,13 @@ def process_event(event_name, event_data, repo, branch, base, remote_exists):
     pull_request_reviewers = os.environ.get('PULL_REQUEST_REVIEWERS')
     pull_request_team_reviewers = os.environ.get('PULL_REQUEST_TEAM_REVIEWERS')
 
-    # Update URL for the 'origin' remote
-    set_git_remote_url(repo.git, github_token, github_repository)
-
     # Push the local changes to the remote branch
     print("Pushing changes.")
     push_result = push_changes(repo.git, branch, commit_message)
     print(push_result)
 
-    # If the remote existed then a PR likely exists and we can finish here
+    # If the remote existed then we are using fixed branch strategy.
+    # A PR should already exist and we can finish here.
     if remote_exists:
         print("Updated pull request branch %s." % branch)
         sys.exit()
@@ -140,7 +119,9 @@ def process_event(event_name, event_data, repo, branch, base, remote_exists):
         base=base,
         head=branch)
     print("Created pull request %d." % pull_request.number)
-    os.system('echo ::set-env name=PULL_REQUEST_NUMBER::%d' % pull_request.number)
+    os.system(
+        'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
+        pull_request.number)
 
     # Set labels, assignees and milestone
     if pull_request_labels is not None:
@@ -157,65 +138,107 @@ def process_event(event_name, event_data, repo, branch, base, remote_exists):
     # Set pull request reviewers and team reviewers
     if pull_request_reviewers is not None:
         print("Requesting reviewers")
-        pull_request.create_review_request(reviewers=cs_string_to_list(pull_request_reviewers))
+        pull_request.create_review_request(
+            reviewers=cs_string_to_list(pull_request_reviewers))
     if pull_request_team_reviewers is not None:
         print("Requesting team reviewers")
-        pull_request.create_review_request(team_reviewers=cs_string_to_list(pull_request_team_reviewers))
+        pull_request.create_review_request(
+            team_reviewers=cs_string_to_list(pull_request_team_reviewers))
 
 
-# Get the JSON event data
+# Fetch environment variables
+github_token = os.environ['GITHUB_TOKEN']
+github_repository = os.environ['GITHUB_REPOSITORY']
+github_ref = os.environ['GITHUB_REF']
 event_name = os.environ['GITHUB_EVENT_NAME']
+# Get the JSON event data
 event_data = get_github_event(os.environ['GITHUB_EVENT_PATH'])
-# Check if this event should be ignored
-skip_ignore_event = bool(os.environ.get('SKIP_IGNORE'))
-if skip_ignore_event or not ignore_event(event_name, event_data):
-    # Set the repo to the working directory
-    repo = Repo(os.getcwd())
 
-    # Fetch/Set the branch name
-    branch = os.getenv('PULL_REQUEST_BRANCH', 'create-pull-request/patch')
-    # Set the current branch as the target base branch
-    base = os.environ['GITHUB_REF'][11:]
+# Set the repo to the working directory
+repo = Repo(os.getcwd())
+# Get the default for author email and name
+author_email, author_name = get_author_default(event_name, event_data)
+# Set commit author overrides
+author_email = os.getenv('COMMIT_AUTHOR_EMAIL', author_email)
+author_name = os.getenv('COMMIT_AUTHOR_NAME', author_name)
+# Set git configuration
+set_git_config(repo.git, author_email, author_name)
+# Update URL for the 'origin' remote
+set_git_remote_url(repo.git, github_token, github_repository)
 
-    # Skip if the current branch is a PR branch created by this action
-    if base.startswith(branch):
-        print("Branch '%s' was created by this action. Skipping." % base)
+# Fetch/Set the branch name
+branch_prefix = os.getenv(
+    'PULL_REQUEST_BRANCH',
+    'create-pull-request/patch')
+# Fetch an optional base branch override
+base_override = os.environ.get('PULL_REQUEST_BASE')
+
+# Set the base branch
+if base_override is not None:
+    base = base_override
+    checkout_branch(repo.git, True, base)
+elif github_ref.startswith('refs/pull/'):
+    # Switch to the merging branch instead of the merge commit
+    base = os.environ['GITHUB_HEAD_REF']
+    repo.git.checkout(base)
+else:
+    base = github_ref[11:]
+
+# Skip if the current branch is a PR branch created by this action.
+# This may occur when using a PAT instead of GITHUB_TOKEN.
+if base.startswith(branch_prefix):
+    print("Branch '%s' was created by this action. Skipping." % base)
+    sys.exit()
+
+# Fetch an optional environment variable to determine the branch suffix
+branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
+if branch_suffix == "short-commit-hash":
+    # Suffix with the short SHA1 hash
+    branch = "%s-%s" % (branch_prefix, get_head_short_sha1(repo))
+elif branch_suffix == "timestamp":
+    # Suffix with the current timestamp
+    branch = "%s-%s" % (branch_prefix, int(time.time()))
+elif branch_suffix == "random":
+    # Suffix with the current timestamp
+    branch = "%s-%s" % (branch_prefix, get_random_suffix())
+elif branch_suffix == "none":
+    # Fixed branch name
+    branch = branch_prefix
+else:
+    print(
+        "Branch suffix '%s' is not a valid value." %
+        branch_suffix)
+    sys.exit(1)
+
+# Check if the remote branch exists
+remote_exists = remote_branch_exists(repo, branch)
+
+if remote_exists:
+    if branch_suffix == 'short-commit-hash':
+        # A remote branch already exists for the HEAD commit
+        print(
+            "Pull request branch '%s' already exists for this commit. Skipping." %
+            branch)
         sys.exit()
+    elif branch_suffix in ['timestamp', 'random']:
+        # Generated branch name clash with an existing branch
+        print(
+            "Pull request branch '%s' already exists. Please re-run." %
+            branch)
+        sys.exit(1)
 
-    # Fetch an optional environment variable to determine the branch suffix
-    branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
-    if branch_suffix == "short-commit-hash":
-        # Suffix with the short SHA1 hash
-        branch = "%s-%s" % (branch, get_head_short_sha1(repo))
-    elif branch_suffix == "timestamp":
-        # Suffix with the current timestamp
-        branch = "%s-%s" % (branch, int(time.time()))
-    elif branch_suffix == "random":
-        # Suffix with the current timestamp
-        branch = "%s-%s" % (branch, get_random_suffix())
+# Checkout branch
+checkout_branch(repo.git, remote_exists, branch)
 
-    # Check if the remote branch exists
-    remote_exists = remote_branch_exists(repo, branch)
-
-    # If using short commit hash prefixes, check if a remote 
-    # branch already exists for this HEAD commit
-    if branch_suffix == 'short-commit-hash' and remote_exists:
-        print("Pull request branch '%s' already exists for this commit. Skipping." % branch)
-        sys.exit()
-
-    # Get the default for author email and name
-    author_email, author_name = get_author_default(event_name, event_data)
-    # Set commit author overrides
-    author_email = os.getenv('COMMIT_AUTHOR_EMAIL', author_email)
-    author_name = os.getenv('COMMIT_AUTHOR_NAME', author_name)
-    # Set git configuration
-    set_git_config(repo.git, author_email, author_name)
-    # Checkout branch
-    checkout_branch(repo.git, remote_exists, branch)
-
-    # Check if there are changes to pull request
-    if repo.is_dirty() or len(repo.untracked_files) > 0:
-        print("Repository has modified or untracked files.")
-        process_event(event_name, event_data, repo, branch, base, remote_exists)
-    else:
-        print("Repository has no modified or untracked files. Skipping.")
+# Check if there are changes to pull request
+if repo.is_dirty() or len(repo.untracked_files) > 0:
+    print("Repository has modified or untracked files.")
+    process_event(
+        github_token,
+        github_repository,
+        repo,
+        branch,
+        base,
+        remote_exists)
+else:
+    print("Repository has no modified or untracked files. Skipping.")

requirements.txt

@@ -1,2 +1,2 @@
-GitPython==3.0.3
-PyGithub==1.43.8
+GitPython==3.0.4
+PyGithub==1.44