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

New parameters

.github/workflows/repository_dispatch.yml

@@ -1,4 +1,6 @@
-on: push
+on:
+  repository_dispatch:
+    types: [test]
 name: create-pull-request action testing workflow
 jobs:
   createPullRequest:
@@ -14,7 +16,6 @@ jobs:
       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

README.md

@@ -13,19 +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: In general, it's not good practice to modify your repository during workflows.
+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
 
-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.
-
 ```yml
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.0.0
+      uses: peter-evans/create-pull-request@v1.2.0
       env:
-        REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 #### Environment variables
@@ -36,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
 
@@ -48,19 +52,27 @@ 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.
 
 ```yml
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v1.0.0
+      uses: peter-evans/create-pull-request@v1.2.0
       env:
-        REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
+        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

create-pull-request.py

@@ -2,6 +2,7 @@
 ''' Create Pull Request '''
 import json
 import os
+import time
 from git import Repo
 from github import Github
 
@@ -9,21 +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
-    # 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
 
 
@@ -34,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
 
 
@@ -50,7 +61,7 @@ def set_git_config(git, email, 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):
@@ -68,11 +79,10 @@ def create_pull_request(token, repo, head, base, title, body):
         head=head)
 
 
-def process_event(github_event, repo, branch, base):
+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']
-    repo_access_token = os.environ['REPO_ACCESS_TOKEN']
     # Fetch remaining optional environment variables
     commit_message = os.getenv(
         'COMMIT_MESSAGE',
@@ -85,11 +95,11 @@ def process_event(github_event, repo, branch, base):
         "[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)
     # 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.")
@@ -110,9 +120,11 @@ def process_event(github_event, repo, branch, base):
 
 
 # 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())
 
@@ -123,15 +135,21 @@ if not ignore_event(github_event):
 
     # Skip if the current branch is a PR branch created by this action
     if not base.startswith(branch):
-        # Suffix with the short SHA1 hash
-        branch = "%s-%s" % (branch, get_head_short_sha1(repo))
+        # 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))
 
         # 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)
+                process_event(event_name, event_data, repo, branch, base)
             else:
                 print("Repository has no modified or untracked files. Skipping.")
         else:

requirements.txt

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