Merge remote-tracking branch 'origin/master'

Update dependency GitPython to v3.0.3

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

@@ -10,23 +10,31 @@ jobs:
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
-    - uses: actions/checkout@v1
-    - name: Create report file
-      if:  matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
-      run: touch report.txt
-    - name: Create report file (windows)
-      if:  matrix.platform == 'windows-latest'
-      run: type NUL > report.txt
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@multi-platform-release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        COMMIT_MESSAGE: 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_TITLE: '[Example] Add report file'
-        PULL_REQUEST_LABELS: report, automated pr
-        PULL_REQUEST_ASSIGNEES: peter-evans
-        PULL_REQUEST_REVIEWERS: peter-evans
-        PULL_REQUEST_MILESTONE: 1
-        PULL_REQUEST_BRANCH: example-patches
-        BRANCH_SUFFIX: 'timestamp'
+      - uses: actions/checkout@v1
+      - name: Create report file
+        if:  matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
+        run: date +%s > report.txt
+      - name: Create report file (windows)
+        if:  matrix.platform == 'windows-latest'
+        run: echo %DATE% %TIME% > report.txt
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@multi-platform-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MESSAGE: 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_TITLE: '[Example] Add report file'
+          PULL_REQUEST_LABELS: report, automated pr
+          PULL_REQUEST_ASSIGNEES: peter-evans
+          PULL_REQUEST_REVIEWERS: peter-evans
+          PULL_REQUEST_MILESTONE: 1
+          PULL_REQUEST_BRANCH: example-patches
+          BRANCH_SUFFIX: 'random'
+      - name: Check output environment variable
+        if:  matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
+        run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"
+      - name: Check output environment variable (windows)
+        if:  matrix.platform == 'windows-latest'
+        run: echo Pull Request Number - %PULL_REQUEST_NUMBER%

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

@@ -6,19 +6,23 @@ jobs:
   createPullRequest:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Create report file
-      run: touch report.txt
-    - name: Create Pull Request
-      uses: ./
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        COMMIT_MESSAGE: 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_TITLE: '[Example] Add report file'
-        PULL_REQUEST_LABELS: report, automated pr
-        PULL_REQUEST_ASSIGNEES: peter-evans
-        PULL_REQUEST_REVIEWERS: peter-evans
-        PULL_REQUEST_MILESTONE: 1
-        PULL_REQUEST_BRANCH: example-patches
-        BRANCH_SUFFIX: short-commit-hash
+      - uses: actions/checkout@v1
+      - name: Create report file
+        run: date +%s > report.txt
+      - name: Create Pull Request
+        uses: ./
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MESSAGE: 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_TITLE: '[Example] Add report file'
+          PULL_REQUEST_LABELS: report, automated pr
+          PULL_REQUEST_ASSIGNEES: peter-evans
+          PULL_REQUEST_REVIEWERS: peter-evans
+          PULL_REQUEST_MILESTONE: 1
+          PULL_REQUEST_BRANCH: example-patches
+          BRANCH_SUFFIX: short-commit-hash
+      - name: Check output environment variable
+        run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"

.github/workflows/push.yml

@@ -0,0 +1,16 @@
+name: Update Docker Hub Description
+on:
+  push:
+    branches:
+    - master
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v2.1.0
+      env:
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+        DOCKERHUB_REPOSITORY: peterevans/create-pull-request

README.md

@@ -1,4 +1,4 @@
-# Create Pull Request
+# <img width="24" height="24" src="logo.svg"> Create Pull Request
 [![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Create%20Pull%20Request-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/create-pull-request)
 
 A GitHub action to create a pull request for changes to your repository in the actions workspace.
@@ -10,32 +10,31 @@ 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. 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. The commit will be made using the name and email of the `HEAD` commit author.
 3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
 
-Note: Modifying a repository during workflows is not good practice in general.
-However, this action opens up some interesting possibilities when used carefully.
-This action is experimental and may not work well for some use cases.
-
 ## Usage
 
 Linux
 ```yml
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.3.1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1.4.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 Multi platform - Linux, MacOS, Windows (beta)
 ```yml
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.2.1-multi
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1.4.1-multi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-#### Environment variables
+**Note**: If you want pull requests created by this action to trigger an `on: pull_request` workflow then you must use a Personal Access Token instead of the default `GITHUB_TOKEN`.
+See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) for further details.
+
+### Environment variables
 
 These variables are all optional. If not set, a default value will be used.
 
@@ -48,33 +47,37 @@ These variables are all optional. If not set, a default value will be used.
 - `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) and `timestamp`. 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.
+
+Output environment variables
+
+- `PULL_REQUEST_NUMBER` - The number of the pull request created.
 
 The following parameters are available for debugging and troubleshooting.
 
 - `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow.
 - `SKIP_IGNORE` - If present, the `ignore_event` function will be skipped.
 
-#### Branch naming
+### Branch naming
 
-The variable `PULL_REQUEST_BRANCH` defaults to `create-pull-request/patch`.
-Commits will be made to a branch with this name and suffixed with the short SHA1 commit hash.
+For branch naming there are two strategies. Always create a new branch each time there are changes to be committed, OR, create a fixed-name pull request branch that will be updated with any new commits until it is merged or closed.
 
-e.g.
-```
-create-pull-request/patch-fcdfb59
-create-pull-request/patch-394710b
-```
+#### Strategy A - Always create a new pull request branch (default)
 
-Alternatively, branches can be suffixed with a timestamp by setting the environment variable `BRANCH_SUFFIX` to the value `timestamp`. This option must be used if multiple pull requests will be created during the execution of a workflow.
+For this strategy there are three options to suffix the branch name.
+The branch name is defined by the variable `PULL_REQUEST_BRANCH` and defaults to `create-pull-request/patch`. The following options are values for `BRANCH_SUFFIX`.
 
-e.g.
-```
-create-pull-request/patch-1569322532
-create-pull-request/patch-1569322552
-```
+- `short-commit-hash` (default) - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
 
-#### Ignoring files
+- `timestamp` - Commits will be made to a branch suffixed by a timestamp. e.g. `create-pull-request/patch-1569322532`, `create-pull-request/patch-1569322552`
+
+- `random` - Commits will be made to a branch suffixed with a random alpha-numeric string. This option should be used if multiple pull requests will be created during the execution of a workflow. e.g. `create-pull-request/patch-6qj97jr`, `create-pull-request/patch-5jrjhvd`
+
+#### Strategy B - Create and update a pull request branch
+
+To use this strategy, set `BRANCH_SUFFIX` to the value `none`. The variable `PULL_REQUEST_BRANCH` defaults to `create-pull-request/patch`. Commits will be made to this branch and a pull request created. Any subsequent changes will be committed to the *same* branch and reflected in the existing pull request.
+
+### Ignoring files
 
 If there are files or directories you want to ignore you can simply add them to a `.gitignore` file at the root of your repository. The action will respect this file.
 
@@ -91,22 +94,26 @@ jobs:
   createPullRequest:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Create report file
-      run: touch report.txt
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.3.1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        COMMIT_MESSAGE: 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_TITLE: '[Example] New report'
-        PULL_REQUEST_LABELS: report, automated pr
-        PULL_REQUEST_ASSIGNEES: peter-evans
-        PULL_REQUEST_REVIEWERS: peter-evans
-        PULL_REQUEST_MILESTONE: 1
-        PULL_REQUEST_BRANCH: example-patches
-        BRANCH_SUFFIX: short-commit-hash
+      - uses: actions/checkout@v1
+      - name: Create report file
+        run: date +%s > report.txt
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1.4.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MESSAGE: 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_TITLE: '[Example] Add report file'
+          PULL_REQUEST_LABELS: report, automated pr
+          PULL_REQUEST_ASSIGNEES: peter-evans
+          PULL_REQUEST_REVIEWERS: peter-evans
+          PULL_REQUEST_MILESTONE: 1
+          PULL_REQUEST_BRANCH: example-patches
+          BRANCH_SUFFIX: short-commit-hash
+      - name: Check output environment variable
+        run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"
 ```
 
 This configuration will create pull requests that look like this:
@@ -115,4 +122,4 @@ This configuration will create pull requests that look like this:
 
 ## License
 
-MIT License - see the [LICENSE](LICENSE) file for details
+[MIT](LICENSE)

action.yml

@@ -0,0 +1,9 @@
+name: 'Create Pull Request'
+author: 'Peter Evans'
+description: 'Creates a pull request for changes to your repository in the actions workspace'
+runs:
+  using: 'docker'
+  image: 'docker://peterevans/create-pull-request:1.5.0'
+branding:
+  icon: 'git-pull-request'  
+  color: 'gray-dark'

create-pull-request.py

@@ -2,6 +2,9 @@
 ''' Create Pull Request '''
 import json
 import os
+import random
+import string
+import sys
 import time
 from git import Repo
 from github import Github
@@ -34,7 +37,15 @@ def ignore_event(event_name, event_data):
     return False
 
 
-def pr_branch_exists(repo, branch):
+def get_head_short_sha1(repo):
+    return repo.git.rev_parse('--short', 'HEAD')
+
+
+def get_random_suffix(size=7, chars=string.ascii_lowercase + string.digits):
+    return ''.join(random.choice(chars) for _ in range(size))
+
+
+def remote_branch_exists(repo, branch):
     for ref in repo.remotes.origin.refs:
         if ref.name == ("origin/%s" % branch):
             return True
@@ -51,10 +62,6 @@ def get_head_author(event_name, event_data):
     return email, name
 
 
-def get_head_short_sha1(repo):
-    return repo.git.rev_parse('--short', 'HEAD')
-
-
 def set_git_config(git, email, name):
     git.config('--global', 'user.email', '"%s"' % email)
     git.config('--global', 'user.name', '"%s"' % name)
@@ -64,11 +71,23 @@ 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))
 
 
-def commit_changes(git, branch, commit_message):
-    git.checkout('HEAD', b=branch)
+def checkout_branch(git, remote_exists, branch):
+    if remote_exists:
+        git.stash('--include-untracked')
+        git.checkout(branch)
+        try:
+            git.stash('pop')
+        except:
+            git.checkout('--theirs', '.')
+            git.reset()
+    else:
+        git.checkout('HEAD', b=branch)
+
+
+def push_changes(git, branch, commit_message):
     git.add('-A')
     git.commit(m=commit_message)
-    return git.push('--set-upstream', 'origin', branch)
+    return git.push('-f', '--set-upstream', 'origin', branch)
 
 
 def cs_string_to_list(str):
@@ -78,7 +97,7 @@ def cs_string_to_list(str):
     return list(filter(None, l))
 
 
-def process_event(event_name, event_data, repo, branch, base):
+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']
@@ -99,17 +118,18 @@ def process_event(event_name, event_data, repo, branch, base):
     pull_request_reviewers = os.environ.get('PULL_REQUEST_REVIEWERS')
     pull_request_team_reviewers = os.environ.get('PULL_REQUEST_TEAM_REVIEWERS')
 
-    # Get the HEAD committer's email and name
-    author_email, author_name = get_head_author(event_name, event_data)
-    # 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)
 
-    # Commit the repository changes
-    print("Committing changes.")
-    commit_result = commit_changes(repo.git, branch, commit_message)
-    print(commit_result)
+    # 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 remote_exists:
+        print("Updated pull request branch %s." % branch)
+        sys.exit()
 
     # Create the pull request
     print("Creating a request to pull %s into %s." % (branch, base))
@@ -120,6 +140,7 @@ def process_event(event_name, event_data, repo, branch, base):
         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)
 
     # Set labels, assignees and milestone
     if pull_request_labels is not None:
@@ -157,28 +178,41 @@ if skip_ignore_event or not ignore_event(event_name, event_data):
     base = os.environ['GITHUB_REF'][11:]
 
     # Skip if the current branch is a PR branch created by this action
-    if not base.startswith(branch):
-        # Fetch an optional environment variable to determine the branch suffix
-        branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
-        if branch_suffix == "timestamp":
-            # Suffix with the current timestamp
-            branch = "%s-%s" % (branch, int(time.time()))
-        else:
-            # Suffix with the short SHA1 hash
-            branch = "%s-%s" % (branch, get_head_short_sha1(repo))
+    if base.startswith(branch):
+        print("Branch '%s' was created by this action. Skipping." % base)
+        sys.exit()
 
-        # Check if a PR branch already exists for this HEAD commit
-        if not pr_branch_exists(repo, 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)
-            else:
-                print("Repository has no modified or untracked files. Skipping.")
-        else:
-            print(
-                "Pull request branch '%s' already exists for this commit. Skipping." %
-                branch)
+    # 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 HEAD committer's email and name
+    author_email, author_name = get_head_author(event_name, event_data)
+    # 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(
-            "Branch '%s' was created by this action. Skipping." % base)
+        print("Repository has no modified or untracked files. Skipping.")

logo.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="43%" height="43%" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" style="color: #000000;"><title>git-pull-request</title>
+  <circle cx="18" cy="18" r="3"></circle>
+  <circle cx="6" cy="6" r="3"></circle>
+  <path d="M13 6h3a2 2 0 0 1 2 2v7"></path>
+  <line x1="6" y1="9" x2="6" y2="21"></line>
+</svg>

requirements.txt

@@ -1,2 +1,2 @@
-GitPython==3.0.2
+GitPython==3.0.3
 PyGithub==1.43.8