Update README

Issue params

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

@@ -0,0 +1,40 @@
+on:
+  repository_dispatch:
+    types: [create-pull-request-multi]
+name: create-pull-request workflow
+jobs:
+  createPullRequest:
+    name: Testing on ${{ matrix.platform }}
+    strategy:
+      matrix:
+        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: 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

@@ -0,0 +1,28 @@
+on:
+  repository_dispatch:
+    types: [create-pull-request]
+name: create-pull-request workflow
+jobs:
+  createPullRequest:
+    runs-on: ubuntu-latest
+    steps:
+      - 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

@@ -1,21 +0,0 @@
-on: push
-name: create-pull-request action testing workflow
-jobs:
-  createPullRequest:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-    - name: Create report file
-      uses: finnp/create-file-action@1.0.0
-      env:
-        FILE_DATA: This is created to test create-pull-request action.
-        FILE_NAME: report.txt
-    - name: Create Pull Request
-      uses: ./
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_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_BRANCH: test-patches
-        PULL_REQUEST_TITLE: '[Test] Add report file'

.gitignore

@@ -0,0 +1 @@
+.DS_Store

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7.3
+FROM alpine:3.10.2
 
 LABEL maintainer="Peter Evans <mail@peterevans.dev>"
 LABEL repository="https://github.com/peter-evans/create-pull-request"
@@ -11,8 +11,10 @@ LABEL com.github.actions.color="gray-dark"
 
 COPY LICENSE README.md /
 
+RUN apk add python3-dev git git-lfs
+
 COPY requirements.txt /tmp/
-RUN pip install --requirement /tmp/requirements.txt
+RUN pip3 install --requirement /tmp/requirements.txt
 
 COPY create-pull-request.py /create-pull-request.py
-ENTRYPOINT [ "/create-pull-request.py" ]
+ENTRYPOINT [ "/create-pull-request.py" ]

README.md

@@ -3,50 +3,85 @@
 
 A GitHub action to create a pull request for changes to your repository in the actions workspace.
 
-Changes to a repository in the actions workspace persist between actions in a workflow.
-This action is designed to be used in conjunction with other actions that modify or add files to your repository.
+Changes to a repository in the Actions workspace persist between steps in a workflow.
+This action is designed to be used in conjunction with other steps that modify or add files to your repository.
 The changes will be automatically committed to a new branch and a pull request created.
 
 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.
+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.
 3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
 
-Note: In general, it's not good practice to modify your repository during workflows.
-This action is experimental and may not work well for repositories that have a very high frequency of commits.
-
 ## Usage
 
-The default `GITHUB_TOKEN` does not have the access neccessary for this action to work correctly.
-Create a new `repo` scoped token [here](https://github.com/settings/tokens) and pass that as a secret to the `REPO_ACCESS_TOKEN` environment variable.
-
+Linux
 ```yml
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.0.0
-      env:
-        REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1.4.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Multi platform - Linux, MacOS, Windows (beta)
+```yml
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1.3.1-multi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 #### Environment variables
 
 These variables are all optional. If not set, a default value will be used.
 
-- `PULL_REQUEST_BRANCH` - The branch name. See **Branch naming** below for details.
 - `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.
+
+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
 
-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 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)**
+
+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`.
+
+1. `short-commit-hash` (default)
+
+    Commits will be made to a branch suffixed with the short SHA1 commit hash.
+    eg. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
+
+2. `timestamp`
+
+    Commits will be made to a branch suffixed by a timestamp.
+    eg. `create-pull-request/patch-1569322532`, `create-pull-request/patch-1569322552`
+
+3. `random`
+
+    Commits will be made to a branch suffixed with a random alpha-numeric string. This option must be used if multiple pull requests will be created during the execution of a workflow.
+    eg. `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
 
@@ -54,17 +89,37 @@ If there are files or directories you want to ignore you can simply add them to
 
 ## Example
 
-Here is an example that sets all the environment variables.
+Here is an example that sets all the main environment variables.
 
 ```yml
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.0.0
-      env:
-        REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
-        PULL_REQUEST_BRANCH: my-patches
-        COMMIT_MESSAGE: Auto-modify files by my-file-modifier-action
-        PULL_REQUEST_TITLE: Changes from my-file-modifier-action
-        PULL_REQUEST_BODY: This is an auto-generated PR with changes from my-file-modifier-action
+on:
+  repository_dispatch:
+    types: [create-pull-request]
+name: create-pull-request workflow
+jobs:
+  createPullRequest:
+    runs-on: ubuntu-latest
+    steps:
+      - 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.0
+        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:
@@ -73,4 +128,4 @@ This configuration will create pull requests that look like this:
 
 ## License
 
-MIT License - see the [LICENSE](LICENSE) file for details
+[MIT](LICENSE)

create-pull-request.py

@@ -2,6 +2,10 @@
 ''' Create Pull Request '''
 import json
 import os
+import random
+import string
+import sys
+import time
 from git import Repo
 from github import Github
 
@@ -9,71 +13,87 @@ from github import Github
 def get_github_event(github_event_path):
     with open(github_event_path) as f:
         github_event = json.load(f)
-    if os.environ.get('DEBUG_EVENT') is not None:
+    if bool(os.environ.get('DEBUG_EVENT')):
+        print(os.environ['GITHUB_EVENT_NAME'])
         print(json.dumps(github_event, sort_keys=True, indent=2))
     return github_event
 
 
-def ignore_event(github_event):
-    # 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(**github_event)
-    if deleted == "True":
-        print("Ignoring delete branch event.")
-        return True
+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 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
     return False
 
 
-def get_head_author(github_event):
-    email = "{head_commit[author][email]}".format(**github_event)
-    name = "{head_commit[author][name]}".format(**github_event)
+def get_head_author(event_name, event_data):
+    if event_name == "push":
+        email = "{head_commit[author][email]}".format(**event_data)
+        name = "{head_commit[author][name]}".format(**event_data)
+    else:
+        email = os.environ['GITHUB_ACTOR'] + '@users.noreply.github.com'
+        name = os.environ['GITHUB_ACTOR']
     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)
 
 
 def set_git_remote_url(git, token, github_repository):
-    git.remote('set-url', 'origin', "https://%s:x-oauth-basic@github.com/%s" % (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 push_changes(git, remote_exists, branch, commit_message):
     git.add('-A')
     git.commit(m=commit_message)
-    return git.push('--set-upstream', 'origin', branch)
+    if remote_exists:
+        git.checkout(branch)
+        git.rebase('-Xtheirs', '-')
+    else:
+        git.checkout('HEAD', b=branch)
+    return git.push('-f', '--set-upstream', 'origin', branch)
 
 
-def create_pull_request(token, repo, head, base, title, body):
-    return Github(token).get_repo(repo).create_pull(
-        title=title,
-        body=body,
-        base=base,
-        head=head)
+def cs_string_to_list(str):
+    # Split the comma separated string into a list
+    l = [i.strip() for i in str.split(',')]
+    # Remove empty strings
+    return list(filter(None, l))
 
 
-def process_event(github_event, 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']
-    repo_access_token = os.environ['REPO_ACCESS_TOKEN']
-    # Fetch remaining optional environment variables
+    # Fetch optional environment variables with default values
     commit_message = os.getenv(
         'COMMIT_MESSAGE',
         "Auto-committed changes by create-pull-request action")
@@ -83,36 +103,68 @@ def process_event(github_event, repo, branch, base):
     body = os.getenv(
         'PULL_REQUEST_BODY', "Auto-generated pull request by "
         "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
+    # Fetch optional environment variables with no default values
+    pull_request_labels = os.environ.get('PULL_REQUEST_LABELS')
+    pull_request_assignees = os.environ.get('PULL_REQUEST_ASSIGNEES')
+    pull_request_milestone = os.environ.get('PULL_REQUEST_MILESTONE')
+    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(github_event)
+    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, repo_access_token, github_repository)
+    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, remote_exists, 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))
-    pull_request = create_pull_request(
-        github_token,
-        github_repository,
-        branch,
-        base,
-        title,
-        body
-    )
+    github_repo = Github(github_token).get_repo(github_repository)
+    pull_request = github_repo.create_pull(
+        title=title,
+        body=body,
+        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:
+        print("Applying labels")
+        pull_request.as_issue().edit(labels=cs_string_to_list(pull_request_labels))
+    if pull_request_assignees is not None:
+        print("Applying assignees")
+        pull_request.as_issue().edit(assignees=cs_string_to_list(pull_request_assignees))
+    if pull_request_milestone is not None:
+        print("Applying milestone")
+        milestone = github_repo.get_milestone(int(pull_request_milestone))
+        pull_request.as_issue().edit(milestone=milestone)
+
+    # 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))
+    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))
 
 
 # Get the JSON event data
-github_event = get_github_event(os.environ['GITHUB_EVENT_PATH'])
+event_name = os.environ['GITHUB_EVENT_NAME']
+event_data = get_github_event(os.environ['GITHUB_EVENT_PATH'])
 # Check if this event should be ignored
-if not ignore_event(github_event):
+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())
 
@@ -122,22 +174,34 @@ if not ignore_event(github_event):
     base = os.environ['GITHUB_REF'][11:]
 
     # Skip if the current branch is a PR branch created by this action
-    if not base.startswith(branch):
+    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 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(github_event, 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)
+    # 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()
+
+    # 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.")

requirements.txt

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