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

Update dependency GitPython to v3.0.4

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

@@ -18,7 +18,7 @@ Create Pull Request action will:
 Linux
 ```yml
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.2
+        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.2-multi
+        uses: peter-evans/create-pull-request@v1.5.4-multi
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -105,7 +105,7 @@ jobs:
       - name: Create report file
         run: date +%s > report.txt
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.2
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_MESSAGE: Add report file
@@ -157,7 +157,7 @@ jobs:
           ncu -u
           npm install
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.5.2
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_MESSAGE: update dependencies
@@ -201,7 +201,7 @@ jobs:
         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.2
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_MESSAGE: autopep8 action fixes
@@ -232,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.2
+        uses: peter-evans/create-pull-request@v1.5.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }}
@@ -248,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.2
+        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')
 
@@ -99,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):
+def process_event(github_token, github_repository, repo, branch, base, remote_exists):
-    # Fetch required environment variables
-    github_token = os.environ['GITHUB_TOKEN']
-    github_repository = os.environ['GITHUB_REPOSITORY']
     # Fetch optional environment variables with default values
     commit_message = os.getenv(
         'COMMIT_MESSAGE',
@@ -120,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()
@@ -169,60 +146,16 @@ def process_event(event_name, event_data, repo, branch, base, remote_exists):
             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 base branch
-    github_ref = os.environ['GITHUB_REF']
-    if github_ref.startswith('refs/pull/'):
-        # Switch to the merging branch instead of the merge commit
-        base = os.environ['GITHUB_HEAD_REF']
-    else:
-        base = github_ref[11:]
-
-    # Optional base override
-    base = os.getenv('PULL_REQUEST_BASE', base)
-
-    # Checkout the base branch
-    repo.git.checkout(base)
-
-    # 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)
-        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, 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())
-
-    # 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
@@ -230,6 +163,70 @@ if skip_ignore_event or not ignore_event(event_name, event_data):
 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)
+
+# 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)
+
 # Checkout branch
 checkout_branch(repo.git, remote_exists, branch)
 
@@ -237,8 +234,8 @@ if skip_ignore_event or not ignore_event(event_name, event_data):
 if repo.is_dirty() or len(repo.untracked_files) > 0:
     print("Repository has modified or untracked files.")
     process_event(
-            event_name,
+        github_token,
-            event_data,
+        github_repository,
         repo,
         branch,
         base,

requirements.txt

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