Merge pull request #42 from peter-evans/new-params

New parameters

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @peter-evans

.github/workflows/repository_dispatch.yml

@@ -0,0 +1,22 @@
+on:
+  repository_dispatch:
+    types: [test]
+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 }}
+        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'

Dockerfile

@@ -15,4 +15,4 @@ COPY requirements.txt /tmp/
 RUN pip install --requirement /tmp/requirements.txt
 
 COPY create-pull-request.py /create-pull-request.py
-ENTRYPOINT [ "python", "/create-pull-request.py" ]
+ENTRYPOINT [ "/create-pull-request.py" ]

README.md

@@ -4,7 +4,7 @@
 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 useful to pair with other actions that modify or add files to your repository.
+This action is designed to be used in conjunction with other actions 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:
@@ -13,13 +13,17 @@ Create Pull Request action will:
 2. Commit all changes to a new 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 repositories that have a very high frequency of commits.
+
 ## Usage
 
-```hcl
-action "Create Pull Request" {
-  uses = "peter-evans/create-pull-request@v1.0.0"
-  secrets = ["GITHUB_TOKEN"]
-}
+```yml
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v1.2.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 #### Environment variables
@@ -30,6 +34,12 @@ These variables are all optional. If not set, a default value 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.
+- `BRANCH_SUFFIX` - Valid values are `short-commit-hash` and `timestamp`. See **Branch naming** below for details.
+
+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
 
@@ -42,27 +52,37 @@ create-pull-request/patch-fcdfb59
 create-pull-request/patch-394710b
 ```
 
+Alternatively, branches can be suffixed with a timestamp by setting the environment variable `BRANCH_SUFFIX` to the value `timestamp`. This option may be necessary if multiple pull requests will be created during the execution of a workflow.
+
+e.g.
+```
+create-pull-request/patch-1569322532
+create-pull-request/patch-1569322552
+```
+
 #### 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.
 
 ## Example
 
-Here is an example that sets all the environment variables.
+Here is an example that sets all the main environment variables.
 
-```hcl
-action "Create Pull Request" {
-  uses = "peter-evans/create-pull-request@v1.0.0"
-  secrets = ["GITHUB_TOKEN"]
-  env = {
-    PULL_REQUEST_BRANCH = "auto-branch"
-    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"
-  }
-}
+```yml
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v1.2.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_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
 ```
 
+This configuration will create pull requests that look like this:
+
+![Pull Request Example](pull-request-example.png?raw=true)
+
 ## License
 
 MIT License - see the [LICENSE](LICENSE) file for details

create-pull-request.py

@@ -1,6 +1,8 @@
-''' create-pull-request.py '''
+#!/usr/bin/env python3
+''' Create Pull Request '''
 import json
 import os
+import time
 from git import Repo
 from github import Github
 
@@ -8,17 +10,27 @@ 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
-    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
 
 
@@ -29,9 +41,13 @@ def pr_branch_exists(repo, branch):
     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
 
 
@@ -44,6 +60,10 @@ def set_git_config(git, email, name):
     git.config('--global', 'user.name', '"%s"' % 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))
+
+
 def commit_changes(git, branch, commit_message):
     git.checkout('HEAD', b=branch)
     git.add('-A')
@@ -59,7 +79,7 @@ def create_pull_request(token, repo, head, base, title, body):
         head=head)
 
 
-def process_event(github_event, repo, branch):
+def process_event(event_name, event_data, repo, branch, base):
     # Fetch required environment variables
     github_token = os.environ['GITHUB_TOKEN']
     github_repository = os.environ['GITHUB_REPOSITORY']
@@ -75,12 +95,11 @@ def process_event(github_event, repo, branch):
         "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
 
     # 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)
-
-    # Set the target base branch of the pull request
-    base = repo.active_branch.name
+    # Update URL for the 'origin' remote
+    set_git_remote_url(repo.git, github_token, github_repository)
 
     # Commit the repository changes
     print("Committing changes.")
@@ -101,26 +120,42 @@ def process_event(github_event, repo, branch):
 
 
 # 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())
 
     # Fetch/Set the branch name
     branch = os.getenv('PULL_REQUEST_BRANCH', 'create-pull-request/patch')
-    # Suffix with the short SHA1 hash
-    branch = "%s-%s" % (branch, get_head_short_sha1(repo))
+    # Set the current branch as the target base branch
+    base = os.environ['GITHUB_REF'][11:]
 
-    # 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)
+    # 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:
-            print("Repository has no modified or untracked files. Skipping.")
+            # Suffix with the short SHA1 hash
+            branch = "%s-%s" % (branch, get_head_short_sha1(repo))
+
+        # 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)
     else:
         print(
-            "Pull request branch '%s' already exists for this commit. Skipping." %
-            branch)
+            "Branch '%s' was created by this action. Skipping." % base)

renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

requirements.txt

@@ -1,2 +1,2 @@
-GitPython==2.1.11
-PyGithub==1.43.7
+GitPython==3.0.2
+PyGithub==1.43.8