jiriks74/create-pull-request
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge branch 'multi-platform' into multi-platform-release

Browse source
This commit is contained in:
Peter Evans 2019-10-14 02:01:51 +09:00
commit 83c11ef20d
2 changed files with 58 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -10,7 +10,7 @@ The changes will be automatically committed to a new branch and a pull request c
Create Pull Request action will: Create Pull Request action will:
1. Check for repository changes in the Actions workspace. This includes untracked (new) files as well as modified files. 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. 2. Commit all changes to a new branch, or update an existing pull request branch.
3. Create a pull request to merge the new branch into the currently active branch executing the workflow. 3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
## Usage ## Usage
@ -18,7 +18,7 @@ Create Pull Request action will:
Linux Linux
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.5.0 uses: peter-evans/create-pull-request@v1.5.1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
@ -26,7 +26,7 @@ Linux
Multi platform - Linux, MacOS, Windows (beta) Multi platform - Linux, MacOS, Windows (beta)
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.5.0-multi uses: peter-evans/create-pull-request@v1.5.1-multi
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
@ -36,23 +36,29 @@ See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) f
### Environment variables ### Environment variables
These variables are all optional. If not set, a default value will be used. These variables are *all optional*. If not set, sensible default values will be used.
- `COMMIT_MESSAGE` - The message to use when committing changes. | Name | Description | Default |
- `PULL_REQUEST_TITLE` - The title of the pull request. | --- | --- | --- |
- `PULL_REQUEST_BODY` - The body of the pull request. | `COMMIT_MESSAGE` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` |
- `PULL_REQUEST_LABELS` - A comma separated list of labels. | `COMMIT_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. |
- `PULL_REQUEST_ASSIGNEES` - A comma separated list of assignees (GitHub usernames). | `COMMIT_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. |
- `PULL_REQUEST_REVIEWERS` - A comma separated list of reviewers (GitHub usernames) to request a review from. | `PULL_REQUEST_TITLE` | The title of the pull request. | `Auto-generated by create-pull-request action` |
- `PULL_REQUEST_TEAM_REVIEWERS` - A comma separated list of GitHub teams to request a review from. | `PULL_REQUEST_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` |
- `PULL_REQUEST_MILESTONE` - The number of the milestone to associate this pull request with. | `PULL_REQUEST_LABELS` | A comma separated list of labels. | none |
- `PULL_REQUEST_BRANCH` - The branch name. See **Branch naming** below for details. | `PULL_REQUEST_ASSIGNEES` | A comma separated list of assignees (GitHub usernames). | none |
- `BRANCH_SUFFIX` - The branch suffix type. Valid values are `short-commit-hash` (default), `timestamp`, `random` and `none`. See **Branch naming** below for details. | `PULL_REQUEST_REVIEWERS` | A comma separated list of reviewers (GitHub usernames) to request a review from. | none |
| `PULL_REQUEST_TEAM_REVIEWERS` | A comma separated list of GitHub teams to request a review from. | none |
| `PULL_REQUEST_MILESTONE` | The number of the milestone to associate this pull request with. | none |
| `PULL_REQUEST_BRANCH` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` |
| `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` |
Output environment variables **Output environment variables**
- `PULL_REQUEST_NUMBER` - The number of the pull request created. - `PULL_REQUEST_NUMBER` - The number of the pull request created.
**Debug environment variables**
The following parameters are available for debugging and troubleshooting. The following parameters are available for debugging and troubleshooting.
- `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow. - `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow.
@ -98,10 +104,12 @@ jobs:
- name: Create report file - name: Create report file
run: date +%s > report.txt run: date +%s > report.txt
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.5.0 uses: peter-evans/create-pull-request@v1.5.1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COMMIT_MESSAGE: Add report file COMMIT_MESSAGE: Add report file
COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
COMMIT_AUTHOR_NAME: Peter Evans
PULL_REQUEST_TITLE: '[Example] Add report file' PULL_REQUEST_TITLE: '[Example] Add report file'
PULL_REQUEST_BODY: > PULL_REQUEST_BODY: >
This PR is auto-generated by This PR is auto-generated by
@ -134,7 +142,7 @@ The recommended method is to use `set-output`. Note that the step where output v
echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \ echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \
by [create-pull-request](https://github.com/peter-evans/create-pull-request)." by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.5.0 uses: peter-evans/create-pull-request@v1.5.1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }} PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }}
@ -150,7 +158,7 @@ Since the action reads environment variables from the system, it's technically n
echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \ echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \
by [create-pull-request](https://github.com/peter-evans/create-pull-request)." by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.5.0 uses: peter-evans/create-pull-request@v1.5.1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```

43
create-pull-request.py
View file

@ -23,7 +23,7 @@ def ignore_event(event_name, event_data):
if event_name == "push": if event_name == "push":
# Ignore push events on deleted branches # Ignore push events on deleted branches
# The event we want to ignore occurs when a PR is created but the repository owner decides # 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 # 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 # "push" event that we want to ignore, otherwise it will create another branch and PR on
# the same commit. # the same commit.
deleted = "{deleted}".format(**event_data) deleted = "{deleted}".format(**event_data)
@ -68,7 +68,9 @@ def set_git_config(git, email, name):
def set_git_remote_url(git, token, github_repository): 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)) git.remote(
'set-url', 'origin', "https://x-access-token:%s@github.com/%s" %
(token, github_repository))
def checkout_branch(git, remote_exists, branch): def checkout_branch(git, remote_exists, branch):
@ -77,7 +79,7 @@ def checkout_branch(git, remote_exists, branch):
git.checkout(branch) git.checkout(branch)
try: try:
git.stash('pop') git.stash('pop')
except: except BaseException:
git.checkout('--theirs', '.') git.checkout('--theirs', '.')
git.reset() git.reset()
else: else:
@ -140,7 +142,9 @@ def process_event(event_name, event_data, repo, branch, base, remote_exists):
base=base, base=base,
head=branch) head=branch)
print("Created pull request %d." % pull_request.number) print("Created pull request %d." % pull_request.number)
os.system('echo ::set-env name=PULL_REQUEST_NUMBER::%d' % pull_request.number) os.system(
'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
pull_request.number)
# Set labels, assignees and milestone # Set labels, assignees and milestone
if pull_request_labels is not None: if pull_request_labels is not None:
@ -157,10 +161,12 @@ def process_event(event_name, event_data, repo, branch, base, remote_exists):
# Set pull request reviewers and team reviewers # Set pull request reviewers and team reviewers
if pull_request_reviewers is not None: if pull_request_reviewers is not None:
print("Requesting reviewers") print("Requesting reviewers")
pull_request.create_review_request(reviewers=cs_string_to_list(pull_request_reviewers)) pull_request.create_review_request(
reviewers=cs_string_to_list(pull_request_reviewers))
if pull_request_team_reviewers is not None: if pull_request_team_reviewers is not None:
print("Requesting team reviewers") print("Requesting team reviewers")
pull_request.create_review_request(team_reviewers=cs_string_to_list(pull_request_team_reviewers)) pull_request.create_review_request(
team_reviewers=cs_string_to_list(pull_request_team_reviewers))
# Get the JSON event data # Get the JSON event data
@ -174,8 +180,15 @@ if skip_ignore_event or not ignore_event(event_name, event_data):
# Fetch/Set the branch name # Fetch/Set the branch name
branch = os.getenv('PULL_REQUEST_BRANCH', 'create-pull-request/patch') branch = os.getenv('PULL_REQUEST_BRANCH', 'create-pull-request/patch')
# Set the current branch as the target base branch
base = os.environ['GITHUB_REF'][11:] # Set the base branch
github_ref = os.environ['GITHUB_REF']
if github_ref.startswith('refs/pull/'):
base = os.environ['GITHUB_HEAD_REF']
# Reset to the merging branch instead of the merge commit
repo.git.checkout(base)
else:
base = github_ref[11:]
# Skip if the current branch is a PR branch created by this action # Skip if the current branch is a PR branch created by this action
if base.startswith(branch): if base.startswith(branch):
@ -197,10 +210,12 @@ if skip_ignore_event or not ignore_event(event_name, event_data):
# Check if the remote branch exists # Check if the remote branch exists
remote_exists = remote_branch_exists(repo, branch) remote_exists = remote_branch_exists(repo, branch)
# If using short commit hash prefixes, check if a remote # If using short commit hash prefixes, check if a remote
# branch already exists for this HEAD commit # branch already exists for this HEAD commit
if branch_suffix == 'short-commit-hash' and remote_exists: if branch_suffix == 'short-commit-hash' and remote_exists:
print("Pull request branch '%s' already exists for this commit. Skipping." % branch) print(
"Pull request branch '%s' already exists for this commit. Skipping." %
branch)
sys.exit() sys.exit()
# Get the default for author email and name # Get the default for author email and name
@ -216,6 +231,12 @@ if skip_ignore_event or not ignore_event(event_name, event_data):
# Check if there are changes to pull request # Check if there are changes to pull request
if repo.is_dirty() or len(repo.untracked_files) > 0: if repo.is_dirty() or len(repo.untracked_files) > 0:
print("Repository has modified or untracked files.") print("Repository has modified or untracked files.")
process_event(event_name, event_data, repo, branch, base, remote_exists) process_event(
event_name,
event_data,
repo,
branch,
base,
remote_exists)
else: else:
print("Repository has no modified or untracked files. Skipping.") print("Repository has no modified or untracked files. Skipping.")