Merge pull request #83 from peter-evans/dev

Add inputs for committer-name and committer-email

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

@@ -36,6 +36,8 @@ jobs:
           assignees: peter-evans
           reviewers: peter-evans
           milestone: 1
+          project: Example Project
+          project-column: To do
           branch: example-patches
           branch-suffix: random
       - name: Check outputs

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

@@ -28,6 +28,8 @@ jobs:
           assignees: peter-evans
           reviewers: peter-evans
           milestone: 1
+          project: Example Project
+          project-column: To do
           branch: example-patches
           branch-suffix: short-commit-hash
       - name: Check outputs

.github/workflows/slash-command-dispatch.yml

@@ -0,0 +1,16 @@
+name: Slash Command Dispatch
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  slashCommandDispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Slash Command Dispatch
+        uses: peter-evans/slash-command-dispatch@v1
+        with:
+          token: ${{ secrets.REPO_ACCESS_TOKEN }}
+          reaction-token: ${{ secrets.GITHUB_TOKEN }}
+          commands: test
+          permission: admin
+          repository: peter-evans/create-pull-request-tests

README.md

@@ -36,15 +36,19 @@ These inputs are *all optional*. If not set, sensible default values will be use
 | Name | Description | Default |
 | --- | --- | --- |
 | `commit-message` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` |
-| `author-email` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>@users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. |
 | `author-name` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>, the GitHub user that initiated the event. |
+| `author-email` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>@users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. |
+| `committer-name` | The name of the committer. | Defaults to match `author-name` |
+| `committer-email` | The email address of the committer. | Defaults to match `author-email` |
 | `title` | The title of the pull request. | `Auto-generated by create-pull-request action` |
 | `body` | The body of the pull request. | `Auto-generated pull request by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action` |
-| `labels` | A comma separated list of labels. | none |
-| `assignees` | A comma separated list of assignees (GitHub usernames). | none |
-| `reviewers` | A comma separated list of reviewers (GitHub usernames) to request a review from. | none |
-| `team-reviewers` | A comma separated list of GitHub teams to request a review from. | none |
-| `milestone` | The number of the milestone to associate this pull request with. | none |
+| `labels` | A comma separated list of labels. | |
+| `assignees` | A comma separated list of assignees (GitHub usernames). | |
+| `reviewers` | A comma separated list of reviewers (GitHub usernames) to request a review from. | |
+| `team-reviewers` | A comma separated list of GitHub teams to request a review from. | |
+| `milestone` | The number of the milestone to associate this pull request with. | |
+| `project` | The name of the project for which a card should be created. Requires `project-column`. | |
+| `project-column` | The name of the project column under which a card should be created. Requires `project`. | |
 | `branch` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` |
 | `base` | Sets the pull request base branch. | Defaults to the currently checked out branch, `GITHUB_REF`. For `pull_request` events, `GITHUB_HEAD_REF` |
 | `branch-suffix` | The branch suffix type. Valid values are `short-commit-hash`, `timestamp`, `random` and `none`. See **Branch naming** below for details. | `short-commit-hash` |
@@ -83,12 +87,27 @@ The branch name is defined by the input `branch` and defaults to `create-pull-re
 
 #### Strategy B - Create and update a pull request branch
 
-To use this strategy, set `branch-suffix` to the value `none`. The input `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.
+To use this strategy, set `branch-suffix` to the value `none`. The input `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 open pull request. If the pull request is merged or closed a new one will be created.
 
 ### 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.
 
+### Commit as github-actions[bot]
+
+You can make commits that appear to be made by the GitHub Actions bot as follows.
+
+```yml
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          author-name: github-actions[bot]
+          author-email: 41898282+github-actions[bot]@users.noreply.github.com
+          committer-name: GitHub
+          committer-email: noreply@github.com
+```
+
 ## Reference Example
 
 The following workflow is a reference example that sets all the main inputs.
@@ -124,6 +143,8 @@ jobs:
           assignees: peter-evans
           reviewers: peter-evans
           milestone: 1
+          project: Example Project
+          project-column: To do
           branch: example-patches
           branch-suffix: short-commit-hash
       - name: Check outputs

action.yml

@@ -6,10 +6,14 @@ inputs:
     required: true
   commit-message:
     description: 'The message to use when committing changes.'
-  author-email:
-    description: 'The email address of the commit author.'
   author-name:
     description: 'The name of the commit author.'
+  author-email:
+    description: 'The email address of the commit author.'
+  committer-name:
+    description: 'The name of the committer.'
+  committer-email:
+    description: 'The email address of the committer.'
   title:
     description: 'The title of the pull request.'
   body:
@@ -24,6 +28,10 @@ inputs:
     description: 'A comma separated list of GitHub teams to request a review from.'
   milestone:
     description: 'The number of the milestone to associate this pull request with.'
+  project:
+    description: 'The name of the project for which a card should be created.'
+  project-column:
+    description: 'The name of the project column under which a card should be created.'
   branch:
     description: 'The pull request branch name.'
   base:

dist/index.js

@@ -978,8 +978,10 @@ async function run() {
     const inputs = {
       token: core.getInput("token"),
       commitMessage: core.getInput("commit-message"),
-      commitAuthorEmail: core.getInput("author-email"),
       commitAuthorName: core.getInput("author-name"),
+      commitAuthorEmail: core.getInput("author-email"),
+      committerName: core.getInput("committer-name"),
+      committerEmail: core.getInput("committer-email"),
       title: core.getInput("title"),
       body: core.getInput("body"),
       labels: core.getInput("labels"),
@@ -987,6 +989,8 @@ async function run() {
       reviewers: core.getInput("reviewers"),
       teamReviewers: core.getInput("team-reviewers"),
       milestone: core.getInput("milestone"),
+      project: core.getInput("project"),
+      projectColumn: core.getInput("project-column"),
       branch: core.getInput("branch"),
       base: core.getInput("base"),
       branchSuffix: core.getInput("branch-suffix"),
@@ -997,8 +1001,10 @@ async function run() {
     // Set environment variables from inputs.
     if (inputs.token) process.env.GITHUB_TOKEN = inputs.token;
     if (inputs.commitMessage) process.env.COMMIT_MESSAGE = inputs.commitMessage;
-    if (inputs.commitAuthorEmail) process.env.COMMIT_AUTHOR_EMAIL = inputs.commitAuthorEmail;
     if (inputs.commitAuthorName) process.env.COMMIT_AUTHOR_NAME = inputs.commitAuthorName;
+    if (inputs.commitAuthorEmail) process.env.COMMIT_AUTHOR_EMAIL = inputs.commitAuthorEmail;
+    if (inputs.committerName) process.env.COMMITTER_NAME = inputs.committerName;
+    if (inputs.committerEmail) process.env.COMMITTER_EMAIL = inputs.committerEmail;
     if (inputs.title) process.env.PULL_REQUEST_TITLE = inputs.title;
     if (inputs.body) process.env.PULL_REQUEST_BODY = inputs.body;
     if (inputs.labels) process.env.PULL_REQUEST_LABELS = inputs.labels;
@@ -1006,6 +1012,8 @@ async function run() {
     if (inputs.reviewers) process.env.PULL_REQUEST_REVIEWERS = inputs.reviewers;
     if (inputs.teamReviewers) process.env.PULL_REQUEST_TEAM_REVIEWERS = inputs.teamReviewers;
     if (inputs.milestone) process.env.PULL_REQUEST_MILESTONE = inputs.milestone;
+    if (inputs.project) process.env.PROJECT_NAME = inputs.project;
+    if (inputs.projectColumn) process.env.PROJECT_COLUMN_NAME = inputs.projectColumn;
     if (inputs.branch) process.env.PULL_REQUEST_BRANCH = inputs.branch;
     if (inputs.base) process.env.PULL_REQUEST_BASE = inputs.base;
     if (inputs.branchSuffix) process.env.BRANCH_SUFFIX = inputs.branchSuffix;

dist/src/create-pull-request.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-''' Create Pull Request '''
+""" Create Pull Request """
 import json
 import os
 import random
@@ -13,18 +13,18 @@ from github import Github, GithubException
 def get_github_event(github_event_path):
     with open(github_event_path) as f:
         github_event = json.load(f)
-    if bool(os.environ.get('DEBUG_EVENT')):
-        print(os.environ['GITHUB_EVENT_NAME'])
+    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 get_head_short_sha1(repo):
-    return repo.git.rev_parse('--short', 'HEAD')
+    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))
+    return "".join(random.choice(chars) for _ in range(size))
 
 
 def remote_branch_exists(repo, branch):
@@ -39,68 +39,99 @@ def get_author_default(event_name, event_data):
         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']
+        email = os.environ["GITHUB_ACTOR"] + "@users.noreply.github.com"
+        name = os.environ["GITHUB_ACTOR"]
     return email, name
 
 
-def set_git_config(git, email, name):
-    print("Configuring git user as '%s <%s>'" % (name, email))
-    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://x-access-token:%s@github.com/%s" %
-        (token, github_repository))
+        "set-url",
+        "origin",
+        "https://x-access-token:%s@github.com/%s" % (token, github_repository),
+    )
 
 
 def checkout_branch(git, remote_exists, branch):
     if remote_exists:
         print("Checking out branch '%s'" % branch)
-        git.stash('--include-untracked')
+        git.stash("--include-untracked")
         git.checkout(branch)
         try:
-            git.stash('pop')
+            git.stash("pop")
         except BaseException:
-            git.checkout('--theirs', '.')
+            git.checkout("--theirs", ".")
             git.reset()
     else:
         print("Creating new branch '%s'" % branch)
-        git.checkout('HEAD', b=branch)
+        git.checkout("HEAD", b=branch)
 
 
 def push_changes(git, branch, commit_message):
-    git.add('-A')
+    git.add("-A")
     git.commit(m=commit_message)
-    return git.push('-f', '--set-upstream', 'origin', branch)
+    return git.push("-f", "--set-upstream", "origin", branch)
 
 
 def cs_string_to_list(str):
     # Split the comma separated string into a list
-    l = [i.strip() for i in str.split(',')]
+    l = [i.strip() for i in str.split(",")]
     # Remove empty strings
     return list(filter(None, l))
 
 
+def create_project_card(github_repo, project_name, project_column_name, pull_request):
+    # Locate the project by name
+    project = None
+    for project_item in github_repo.get_projects("all"):
+        if project_item.name == project_name:
+            project = project_item
+            break
+
+    if not project:
+        print("::warning::Project not found. Unable to create project card.")
+        return
+
+    # Locate the column by name
+    column = None
+    for column_item in project.get_columns():
+        if column_item.name == project_column_name:
+            column = column_item
+            break
+
+    if not column:
+        print("::warning::Project column not found. Unable to create project card.")
+        return
+
+    # Create a project card for the pull request
+    column.create_card(content_id=pull_request.id, content_type="PullRequest")
+    print(
+        "Added pull request #%d to project '%s' under column '%s'"
+        % (pull_request.number, project.name, column.name)
+    )
+
+
 def process_event(github_token, github_repository, repo, branch, base):
     # Fetch optional environment variables with default values
     commit_message = os.getenv(
-        'COMMIT_MESSAGE',
-        "Auto-committed changes by create-pull-request action")
+        "COMMIT_MESSAGE", "Auto-committed changes by create-pull-request action"
+    )
     title = os.getenv(
-        'PULL_REQUEST_TITLE',
-        "Auto-generated by create-pull-request action")
+        "PULL_REQUEST_TITLE", "Auto-generated by create-pull-request action"
+    )
     body = os.getenv(
-        'PULL_REQUEST_BODY', "Auto-generated pull request by "
-        "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
+        "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')
+    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")
+    project_name = os.environ.get("PROJECT_NAME")
+    project_column_name = os.environ.get("PROJECT_COLUMN_NAME")
 
     # Push the local changes to the remote branch
     print("Pushing changes to 'origin/%s'" % branch)
@@ -111,34 +142,30 @@ def process_event(github_token, github_repository, repo, branch, base):
     github_repo = Github(github_token).get_repo(github_repository)
     try:
         pull_request = github_repo.create_pull(
-            title=title,
-            body=body,
-            base=base,
-            head=branch)
-        print("Created pull request #%d (%s => %s)" %
-              (pull_request.number, branch, base))
+            title=title, body=body, base=base, head=branch
+        )
+        print(
+            "Created pull request #%d (%s => %s)" % (pull_request.number, branch, base)
+        )
     except GithubException as e:
         if e.status == 422:
             # Format the branch name
             head_branch = "%s:%s" % (github_repository.split("/")[0], branch)
             # Get the pull request
             pull_request = github_repo.get_pulls(
-                state='open',
-                base=base,
-                head=head_branch)[0]
-            print("Updated pull request #%d (%s => %s)" %
-                  (pull_request.number, branch, base))
+                state="open", base=base, head=head_branch
+            )[0]
+            print(
+                "Updated pull request #%d (%s => %s)"
+                % (pull_request.number, branch, base)
+            )
         else:
             print(str(e))
             sys.exit(1)
 
     # Set the output variables
-    os.system(
-        'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
-        pull_request.number)
-    os.system(
-        'echo ::set-output name=pr_number::%d' %
-        pull_request.number)
+    os.system("echo ::set-env name=PULL_REQUEST_NUMBER::%d" % pull_request.number)
+    os.system("echo ::set-output name=pr_number::%d" % pull_request.number)
 
     # Set labels, assignees and milestone
     if pull_request_labels is not None:
@@ -146,7 +173,9 @@ def process_event(github_token, github_repository, repo, branch, base):
         pull_request.as_issue().edit(labels=cs_string_to_list(pull_request_labels))
     if pull_request_assignees is not None:
         print("Applying assignees '%s'" % pull_request_assignees)
-        pull_request.as_issue().edit(assignees=cs_string_to_list(pull_request_assignees))
+        pull_request.as_issue().edit(
+            assignees=cs_string_to_list(pull_request_assignees)
+        )
     if pull_request_milestone is not None:
         print("Applying milestone '%s'" % pull_request_milestone)
         milestone = github_repo.get_milestone(int(pull_request_milestone))
@@ -157,7 +186,8 @@ def process_event(github_token, github_repository, repo, branch, base):
         print("Requesting reviewers '%s'" % pull_request_reviewers)
         try:
             pull_request.create_review_request(
-                reviewers=cs_string_to_list(pull_request_reviewers))
+                reviewers=cs_string_to_list(pull_request_reviewers)
+            )
         except GithubException as e:
             # Likely caused by "Review cannot be requested from pull request
             # author."
@@ -168,61 +198,89 @@ def process_event(github_token, github_repository, repo, branch, base):
     if pull_request_team_reviewers is not None:
         print("Requesting team reviewers '%s'" % pull_request_team_reviewers)
         pull_request.create_review_request(
-            team_reviewers=cs_string_to_list(pull_request_team_reviewers))
+            team_reviewers=cs_string_to_list(pull_request_team_reviewers)
+        )
+
+    # Create a project card for the pull request
+    if project_name is not None and project_column_name is not None:
+        try:
+            create_project_card(
+                github_repo, project_name, project_column_name, pull_request
+            )
+        except GithubException as e:
+            # Likely caused by "Project already has the associated issue."
+            if e.status == 422:
+                print(
+                    "Create project card failed - %s" % e.data["errors"][0]["message"]
+                )
 
 
 # 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']
+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'])
+event_data = get_github_event(os.environ["GITHUB_EVENT_PATH"])
+
+# Get the default for author email and name
+author_email, author_name = get_author_default(event_name, event_data)
+# Set author name and email overrides
+author_name = os.getenv("COMMIT_AUTHOR_NAME", author_name)
+author_email = os.getenv("COMMIT_AUTHOR_EMAIL", author_email)
+# Set committer name and email overrides
+committer_name = os.getenv("COMMITTER_NAME", author_name)
+committer_email = os.getenv("COMMITTER_EMAIL", author_email)
 
 # Set the repo to the working directory
 repo = Repo(os.getcwd())
-# Get the default for author email and name
-author_email, author_name = get_author_default(event_name, event_data)
-# Set commit author overrides
-author_email = os.getenv('COMMIT_AUTHOR_EMAIL', author_email)
-author_name = os.getenv('COMMIT_AUTHOR_NAME', author_name)
-# Set git configuration
-set_git_config(repo.git, author_email, author_name)
+# Set git environment. This will not persist after the action completes.
+print("Configuring git author as '%s <%s>'" % (author_name, author_email))
+print("Configuring git committer as '%s <%s>'" % (committer_name, committer_email))
+repo.git.update_environment(
+    GIT_AUTHOR_NAME=author_name,
+    GIT_AUTHOR_EMAIL=author_email,
+    GIT_COMMITTER_NAME=committer_name,
+    GIT_COMMITTER_EMAIL=committer_email,
+)
 # 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')
+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')
+base_override = os.environ.get("PULL_REQUEST_BASE")
 
 # Set the base branch
 if base_override is not None:
     base = base_override
     print("Overriding the base with branch '%s'" % base)
     checkout_branch(repo.git, True, base)
-elif github_ref.startswith('refs/pull/'):
+elif github_ref.startswith("refs/pull/"):
     # Check the PR is not raised from a fork of the repository
     head_repo = "{pull_request[head][repo][full_name]}".format(**event_data)
     if head_repo != github_repository:
-        print("::warning::Pull request was raised from a fork of the repository. " +
-        "Limitations on forked repositories have been imposed by GitHub Actions. " +
-        "Unable to continue. Exiting.")
+        print(
+            "::warning::Pull request was raised from a fork of the repository. "
+            + "Limitations on forked repositories have been imposed by GitHub Actions. "
+            + "Unable to continue. Exiting."
+        )
         sys.exit()
     # Switch to the merging branch instead of the merge commit
-    base = os.environ['GITHUB_HEAD_REF']
+    base = os.environ["GITHUB_HEAD_REF"]
     print(
-        "Removing the merge commit by switching to the pull request head branch '%s'" %
-        base)
+        "Removing the merge commit by switching to the pull request head branch '%s'"
+        % base
+    )
     checkout_branch(repo.git, True, base)
-elif github_ref.startswith('refs/heads/'):
+elif github_ref.startswith("refs/heads/"):
     base = github_ref[11:]
     print("Currently checked out base assumed to be branch '%s'" % base)
 else:
-    print(f"::warning::Currently checked out ref '{github_ref}' is not a valid base for a pull request. " +
-    "Unable to continue. Exiting.")
+    print(
+        f"::warning::Currently checked out ref '{github_ref}' is not a valid base for a pull request. "
+        + "Unable to continue. Exiting."
+    )
     sys.exit()
 
 # Skip if the current branch is a PR branch created by this action.
@@ -233,7 +291,7 @@ if base.startswith(branch_prefix):
     sys.exit()
 
 # Fetch an optional environment variable to determine the branch suffix
-branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
+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))
@@ -247,9 +305,7 @@ elif branch_suffix == "none":
     # Fixed branch name
     branch = branch_prefix
 else:
-    print(
-        "Branch suffix '%s' is not a valid value." %
-        branch_suffix)
+    print("Branch suffix '%s' is not a valid value." % branch_suffix)
     sys.exit(1)
 
 # Output head branch
@@ -259,19 +315,22 @@ print("Pull request branch to create/update set to '%s'" % branch)
 remote_exists = remote_branch_exists(repo, branch)
 if remote_exists:
     print(
-        "Pull request branch '%s' already exists as remote branch 'origin/%s'" %
-        (branch, branch))
-    if branch_suffix == 'short-commit-hash':
+        "Pull request branch '%s' already exists as remote branch 'origin/%s'"
+        % (branch, branch)
+    )
+    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)
+            "Pull request branch '%s' already exists for this commit. Skipping."
+            % branch
+        )
         sys.exit()
-    elif branch_suffix in ['timestamp', 'random']:
+    elif branch_suffix in ["timestamp", "random"]:
         # Generated branch name collision with an existing branch
         print(
-            "Pull request branch '%s' collided with a branch of the same name. Please re-run." %
-            branch)
+            "Pull request branch '%s' collided with a branch of the same name. Please re-run."
+            % branch
+        )
         sys.exit(1)
 
 # Checkout branch
@@ -279,19 +338,18 @@ checkout_branch(repo.git, remote_exists, branch)
 
 # Check if there are changes to pull request
 if remote_exists:
-    print("Checking for local working copy changes indicating a " +
-    "diff with existing pull request branch 'origin/%s'" % branch)
+    print(
+        "Checking for local working copy changes indicating a "
+        + "diff with existing pull request branch 'origin/%s'" % branch
+    )
 else:
-    print("Checking for local working copy changes indicating a " +
-    "diff with base 'origin/%s'" % base)
+    print(
+        "Checking for local working copy changes indicating a "
+        + "diff with base 'origin/%s'" % base
+    )
 
 if repo.is_dirty() or len(repo.untracked_files) > 0:
     print("Modified or untracked files detected.")
-    process_event(
-        github_token,
-        github_repository,
-        repo,
-        branch,
-        base)
+    process_event(github_token, github_repository, repo, branch, base)
 else:
     print("No modified or untracked files detected. Skipping.")

examples.md

@@ -282,11 +282,18 @@ jobs:
 
 ### Filtering push events
 
-For workflows using `on: push` you may want to ignore push events for tags and remotes.
-These can be filtered out with the following `if` condition.
+For workflows using `on: push` you may want to ignore push events for tags and only execute for branches. Specifying `branches` causes only events on branches to trigger the workflow. The `'**'` wildcard will match any branch name.
+
+```yml
+on:
+  push:
+    branches:
+      - '**' 
+```
+
+If you have a workflow that contains jobs to handle push events on branches as well as tags, you can make sure that the job where you use `create-pull-request` action only executes when `github.ref` is a branch by using an `if` condition as follows.
 
 ```yml
-name: Create Pull Request
 on: push
 jobs:
   createPullRequest:
@@ -295,6 +302,12 @@ jobs:
     steps:
       - uses: actions/checkout@v1
       ...
+
+  someOtherJob:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      ...
 ```
 
 ### Dynamic configuration using variables

index.js

@@ -23,8 +23,10 @@ async function run() {
     const inputs = {
       token: core.getInput("token"),
       commitMessage: core.getInput("commit-message"),
-      commitAuthorEmail: core.getInput("author-email"),
       commitAuthorName: core.getInput("author-name"),
+      commitAuthorEmail: core.getInput("author-email"),
+      committerName: core.getInput("committer-name"),
+      committerEmail: core.getInput("committer-email"),
       title: core.getInput("title"),
       body: core.getInput("body"),
       labels: core.getInput("labels"),
@@ -32,6 +34,8 @@ async function run() {
       reviewers: core.getInput("reviewers"),
       teamReviewers: core.getInput("team-reviewers"),
       milestone: core.getInput("milestone"),
+      project: core.getInput("project"),
+      projectColumn: core.getInput("project-column"),
       branch: core.getInput("branch"),
       base: core.getInput("base"),
       branchSuffix: core.getInput("branch-suffix"),
@@ -42,8 +46,10 @@ async function run() {
     // Set environment variables from inputs.
     if (inputs.token) process.env.GITHUB_TOKEN = inputs.token;
     if (inputs.commitMessage) process.env.COMMIT_MESSAGE = inputs.commitMessage;
-    if (inputs.commitAuthorEmail) process.env.COMMIT_AUTHOR_EMAIL = inputs.commitAuthorEmail;
     if (inputs.commitAuthorName) process.env.COMMIT_AUTHOR_NAME = inputs.commitAuthorName;
+    if (inputs.commitAuthorEmail) process.env.COMMIT_AUTHOR_EMAIL = inputs.commitAuthorEmail;
+    if (inputs.committerName) process.env.COMMITTER_NAME = inputs.committerName;
+    if (inputs.committerEmail) process.env.COMMITTER_EMAIL = inputs.committerEmail;
     if (inputs.title) process.env.PULL_REQUEST_TITLE = inputs.title;
     if (inputs.body) process.env.PULL_REQUEST_BODY = inputs.body;
     if (inputs.labels) process.env.PULL_REQUEST_LABELS = inputs.labels;
@@ -51,6 +57,8 @@ async function run() {
     if (inputs.reviewers) process.env.PULL_REQUEST_REVIEWERS = inputs.reviewers;
     if (inputs.teamReviewers) process.env.PULL_REQUEST_TEAM_REVIEWERS = inputs.teamReviewers;
     if (inputs.milestone) process.env.PULL_REQUEST_MILESTONE = inputs.milestone;
+    if (inputs.project) process.env.PROJECT_NAME = inputs.project;
+    if (inputs.projectColumn) process.env.PROJECT_COLUMN_NAME = inputs.projectColumn;
     if (inputs.branch) process.env.PULL_REQUEST_BRANCH = inputs.branch;
     if (inputs.base) process.env.PULL_REQUEST_BASE = inputs.base;
     if (inputs.branchSuffix) process.env.BRANCH_SUFFIX = inputs.branchSuffix;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "create-pull-request",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,10 +1,10 @@
 {
   "name": "create-pull-request",
-  "version": "1.7.4",
+  "version": "1.9.0",
   "description": "Creates a pull request for changes to your repository in the actions workspace",
   "main": "index.js",
   "scripts": {
-    "build": "ncc build index.js -o dist"
+    "package": "ncc build index.js -o dist"
   },
   "repository": {
     "type": "git",

src/create-pull-request.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-''' Create Pull Request '''
+""" Create Pull Request """
 import json
 import os
 import random
@@ -13,18 +13,18 @@ from github import Github, GithubException
 def get_github_event(github_event_path):
     with open(github_event_path) as f:
         github_event = json.load(f)
-    if bool(os.environ.get('DEBUG_EVENT')):
-        print(os.environ['GITHUB_EVENT_NAME'])
+    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 get_head_short_sha1(repo):
-    return repo.git.rev_parse('--short', 'HEAD')
+    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))
+    return "".join(random.choice(chars) for _ in range(size))
 
 
 def remote_branch_exists(repo, branch):
@@ -39,68 +39,99 @@ def get_author_default(event_name, event_data):
         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']
+        email = os.environ["GITHUB_ACTOR"] + "@users.noreply.github.com"
+        name = os.environ["GITHUB_ACTOR"]
     return email, name
 
 
-def set_git_config(git, email, name):
-    print("Configuring git user as '%s <%s>'" % (name, email))
-    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://x-access-token:%s@github.com/%s" %
-        (token, github_repository))
+        "set-url",
+        "origin",
+        "https://x-access-token:%s@github.com/%s" % (token, github_repository),
+    )
 
 
 def checkout_branch(git, remote_exists, branch):
     if remote_exists:
         print("Checking out branch '%s'" % branch)
-        git.stash('--include-untracked')
+        git.stash("--include-untracked")
         git.checkout(branch)
         try:
-            git.stash('pop')
+            git.stash("pop")
         except BaseException:
-            git.checkout('--theirs', '.')
+            git.checkout("--theirs", ".")
             git.reset()
     else:
         print("Creating new branch '%s'" % branch)
-        git.checkout('HEAD', b=branch)
+        git.checkout("HEAD", b=branch)
 
 
 def push_changes(git, branch, commit_message):
-    git.add('-A')
+    git.add("-A")
     git.commit(m=commit_message)
-    return git.push('-f', '--set-upstream', 'origin', branch)
+    return git.push("-f", "--set-upstream", "origin", branch)
 
 
 def cs_string_to_list(str):
     # Split the comma separated string into a list
-    l = [i.strip() for i in str.split(',')]
+    l = [i.strip() for i in str.split(",")]
     # Remove empty strings
     return list(filter(None, l))
 
 
+def create_project_card(github_repo, project_name, project_column_name, pull_request):
+    # Locate the project by name
+    project = None
+    for project_item in github_repo.get_projects("all"):
+        if project_item.name == project_name:
+            project = project_item
+            break
+
+    if not project:
+        print("::warning::Project not found. Unable to create project card.")
+        return
+
+    # Locate the column by name
+    column = None
+    for column_item in project.get_columns():
+        if column_item.name == project_column_name:
+            column = column_item
+            break
+
+    if not column:
+        print("::warning::Project column not found. Unable to create project card.")
+        return
+
+    # Create a project card for the pull request
+    column.create_card(content_id=pull_request.id, content_type="PullRequest")
+    print(
+        "Added pull request #%d to project '%s' under column '%s'"
+        % (pull_request.number, project.name, column.name)
+    )
+
+
 def process_event(github_token, github_repository, repo, branch, base):
     # Fetch optional environment variables with default values
     commit_message = os.getenv(
-        'COMMIT_MESSAGE',
-        "Auto-committed changes by create-pull-request action")
+        "COMMIT_MESSAGE", "Auto-committed changes by create-pull-request action"
+    )
     title = os.getenv(
-        'PULL_REQUEST_TITLE',
-        "Auto-generated by create-pull-request action")
+        "PULL_REQUEST_TITLE", "Auto-generated by create-pull-request action"
+    )
     body = os.getenv(
-        'PULL_REQUEST_BODY', "Auto-generated pull request by "
-        "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
+        "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')
+    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")
+    project_name = os.environ.get("PROJECT_NAME")
+    project_column_name = os.environ.get("PROJECT_COLUMN_NAME")
 
     # Push the local changes to the remote branch
     print("Pushing changes to 'origin/%s'" % branch)
@@ -111,34 +142,30 @@ def process_event(github_token, github_repository, repo, branch, base):
     github_repo = Github(github_token).get_repo(github_repository)
     try:
         pull_request = github_repo.create_pull(
-            title=title,
-            body=body,
-            base=base,
-            head=branch)
-        print("Created pull request #%d (%s => %s)" %
-              (pull_request.number, branch, base))
+            title=title, body=body, base=base, head=branch
+        )
+        print(
+            "Created pull request #%d (%s => %s)" % (pull_request.number, branch, base)
+        )
     except GithubException as e:
         if e.status == 422:
             # Format the branch name
             head_branch = "%s:%s" % (github_repository.split("/")[0], branch)
             # Get the pull request
             pull_request = github_repo.get_pulls(
-                state='open',
-                base=base,
-                head=head_branch)[0]
-            print("Updated pull request #%d (%s => %s)" %
-                  (pull_request.number, branch, base))
+                state="open", base=base, head=head_branch
+            )[0]
+            print(
+                "Updated pull request #%d (%s => %s)"
+                % (pull_request.number, branch, base)
+            )
         else:
             print(str(e))
             sys.exit(1)
 
     # Set the output variables
-    os.system(
-        'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
-        pull_request.number)
-    os.system(
-        'echo ::set-output name=pr_number::%d' %
-        pull_request.number)
+    os.system("echo ::set-env name=PULL_REQUEST_NUMBER::%d" % pull_request.number)
+    os.system("echo ::set-output name=pr_number::%d" % pull_request.number)
 
     # Set labels, assignees and milestone
     if pull_request_labels is not None:
@@ -146,7 +173,9 @@ def process_event(github_token, github_repository, repo, branch, base):
         pull_request.as_issue().edit(labels=cs_string_to_list(pull_request_labels))
     if pull_request_assignees is not None:
         print("Applying assignees '%s'" % pull_request_assignees)
-        pull_request.as_issue().edit(assignees=cs_string_to_list(pull_request_assignees))
+        pull_request.as_issue().edit(
+            assignees=cs_string_to_list(pull_request_assignees)
+        )
     if pull_request_milestone is not None:
         print("Applying milestone '%s'" % pull_request_milestone)
         milestone = github_repo.get_milestone(int(pull_request_milestone))
@@ -157,7 +186,8 @@ def process_event(github_token, github_repository, repo, branch, base):
         print("Requesting reviewers '%s'" % pull_request_reviewers)
         try:
             pull_request.create_review_request(
-                reviewers=cs_string_to_list(pull_request_reviewers))
+                reviewers=cs_string_to_list(pull_request_reviewers)
+            )
         except GithubException as e:
             # Likely caused by "Review cannot be requested from pull request
             # author."
@@ -168,61 +198,89 @@ def process_event(github_token, github_repository, repo, branch, base):
     if pull_request_team_reviewers is not None:
         print("Requesting team reviewers '%s'" % pull_request_team_reviewers)
         pull_request.create_review_request(
-            team_reviewers=cs_string_to_list(pull_request_team_reviewers))
+            team_reviewers=cs_string_to_list(pull_request_team_reviewers)
+        )
+
+    # Create a project card for the pull request
+    if project_name is not None and project_column_name is not None:
+        try:
+            create_project_card(
+                github_repo, project_name, project_column_name, pull_request
+            )
+        except GithubException as e:
+            # Likely caused by "Project already has the associated issue."
+            if e.status == 422:
+                print(
+                    "Create project card failed - %s" % e.data["errors"][0]["message"]
+                )
 
 
 # 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']
+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'])
+event_data = get_github_event(os.environ["GITHUB_EVENT_PATH"])
+
+# Get the default for author email and name
+author_email, author_name = get_author_default(event_name, event_data)
+# Set author name and email overrides
+author_name = os.getenv("COMMIT_AUTHOR_NAME", author_name)
+author_email = os.getenv("COMMIT_AUTHOR_EMAIL", author_email)
+# Set committer name and email overrides
+committer_name = os.getenv("COMMITTER_NAME", author_name)
+committer_email = os.getenv("COMMITTER_EMAIL", author_email)
 
 # Set the repo to the working directory
 repo = Repo(os.getcwd())
-# Get the default for author email and name
-author_email, author_name = get_author_default(event_name, event_data)
-# Set commit author overrides
-author_email = os.getenv('COMMIT_AUTHOR_EMAIL', author_email)
-author_name = os.getenv('COMMIT_AUTHOR_NAME', author_name)
-# Set git configuration
-set_git_config(repo.git, author_email, author_name)
+# Set git environment. This will not persist after the action completes.
+print("Configuring git author as '%s <%s>'" % (author_name, author_email))
+print("Configuring git committer as '%s <%s>'" % (committer_name, committer_email))
+repo.git.update_environment(
+    GIT_AUTHOR_NAME=author_name,
+    GIT_AUTHOR_EMAIL=author_email,
+    GIT_COMMITTER_NAME=committer_name,
+    GIT_COMMITTER_EMAIL=committer_email,
+)
 # 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')
+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')
+base_override = os.environ.get("PULL_REQUEST_BASE")
 
 # Set the base branch
 if base_override is not None:
     base = base_override
     print("Overriding the base with branch '%s'" % base)
     checkout_branch(repo.git, True, base)
-elif github_ref.startswith('refs/pull/'):
+elif github_ref.startswith("refs/pull/"):
     # Check the PR is not raised from a fork of the repository
     head_repo = "{pull_request[head][repo][full_name]}".format(**event_data)
     if head_repo != github_repository:
-        print("::warning::Pull request was raised from a fork of the repository. " +
-        "Limitations on forked repositories have been imposed by GitHub Actions. " +
-        "Unable to continue. Exiting.")
+        print(
+            "::warning::Pull request was raised from a fork of the repository. "
+            + "Limitations on forked repositories have been imposed by GitHub Actions. "
+            + "Unable to continue. Exiting."
+        )
         sys.exit()
     # Switch to the merging branch instead of the merge commit
-    base = os.environ['GITHUB_HEAD_REF']
+    base = os.environ["GITHUB_HEAD_REF"]
     print(
-        "Removing the merge commit by switching to the pull request head branch '%s'" %
-        base)
+        "Removing the merge commit by switching to the pull request head branch '%s'"
+        % base
+    )
     checkout_branch(repo.git, True, base)
-elif github_ref.startswith('refs/heads/'):
+elif github_ref.startswith("refs/heads/"):
     base = github_ref[11:]
     print("Currently checked out base assumed to be branch '%s'" % base)
 else:
-    print(f"::warning::Currently checked out ref '{github_ref}' is not a valid base for a pull request. " +
-    "Unable to continue. Exiting.")
+    print(
+        f"::warning::Currently checked out ref '{github_ref}' is not a valid base for a pull request. "
+        + "Unable to continue. Exiting."
+    )
     sys.exit()
 
 # Skip if the current branch is a PR branch created by this action.
@@ -233,7 +291,7 @@ if base.startswith(branch_prefix):
     sys.exit()
 
 # Fetch an optional environment variable to determine the branch suffix
-branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
+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))
@@ -247,9 +305,7 @@ elif branch_suffix == "none":
     # Fixed branch name
     branch = branch_prefix
 else:
-    print(
-        "Branch suffix '%s' is not a valid value." %
-        branch_suffix)
+    print("Branch suffix '%s' is not a valid value." % branch_suffix)
     sys.exit(1)
 
 # Output head branch
@@ -259,19 +315,22 @@ print("Pull request branch to create/update set to '%s'" % branch)
 remote_exists = remote_branch_exists(repo, branch)
 if remote_exists:
     print(
-        "Pull request branch '%s' already exists as remote branch 'origin/%s'" %
-        (branch, branch))
-    if branch_suffix == 'short-commit-hash':
+        "Pull request branch '%s' already exists as remote branch 'origin/%s'"
+        % (branch, branch)
+    )
+    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)
+            "Pull request branch '%s' already exists for this commit. Skipping."
+            % branch
+        )
         sys.exit()
-    elif branch_suffix in ['timestamp', 'random']:
+    elif branch_suffix in ["timestamp", "random"]:
         # Generated branch name collision with an existing branch
         print(
-            "Pull request branch '%s' collided with a branch of the same name. Please re-run." %
-            branch)
+            "Pull request branch '%s' collided with a branch of the same name. Please re-run."
+            % branch
+        )
         sys.exit(1)
 
 # Checkout branch
@@ -279,19 +338,18 @@ checkout_branch(repo.git, remote_exists, branch)
 
 # Check if there are changes to pull request
 if remote_exists:
-    print("Checking for local working copy changes indicating a " +
-    "diff with existing pull request branch 'origin/%s'" % branch)
+    print(
+        "Checking for local working copy changes indicating a "
+        + "diff with existing pull request branch 'origin/%s'" % branch
+    )
 else:
-    print("Checking for local working copy changes indicating a " +
-    "diff with base 'origin/%s'" % base)
+    print(
+        "Checking for local working copy changes indicating a "
+        + "diff with base 'origin/%s'" % base
+    )
 
 if repo.is_dirty() or len(repo.untracked_files) > 0:
     print("Modified or untracked files detected.")
-    process_event(
-        github_token,
-        github_repository,
-        repo,
-        branch,
-        base)
+    process_event(github_token, github_repository, repo, branch, base)
 else:
     print("No modified or untracked files detected. Skipping.")