Compare commits
33 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0d662a3b50 | ||
|
|
727bec37b0 | ||
|
|
66d0146c3a | ||
|
|
1106c316c1 | ||
|
|
790b81a742 | ||
|
|
d347e09c29 | ||
|
|
7bc520d458 | ||
|
|
9388624b4c | ||
|
|
1e9dfb50ae | ||
|
|
443ae6fbfb | ||
|
|
5790dea963 | ||
|
|
aaed200ec8 | ||
|
|
702ab9c078 | ||
|
|
4a1e588164 | ||
|
|
a61c2bcfb7 | ||
|
|
1a853b4e3f | ||
|
|
9d567ac1d1 | ||
|
|
948483f8ff | ||
|
|
96906bfdd9 | ||
|
|
35053dc2fc | ||
|
|
c3a7ec260e | ||
|
|
90f97d7ca1 | ||
|
|
6795aa743d | ||
|
|
617744b952 | ||
|
|
906c9693bf | ||
|
|
37a2b85332 | ||
|
|
8638d1b6f1 | ||
|
|
09f5606222 | ||
|
|
df89c5fb9e | ||
|
|
d0166ffab5 | ||
|
|
c4372cd524 | ||
|
|
125f29f472 | ||
|
|
e9cc2a3f41 |
17
.github/stale.yml
vendored
Normal file
17
.github/stale.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# Number of days of inactivity before an issue becomes stale
|
||||
daysUntilStale: 60
|
||||
# Number of days of inactivity before a stale issue is closed
|
||||
daysUntilClose: 7
|
||||
# Issues with these labels will never be considered stale
|
||||
exemptLabels:
|
||||
- pinned
|
||||
- security
|
||||
# Label to use when marking an issue as stale
|
||||
staleLabel: wontfix
|
||||
# Comment to post when marking an issue as stale. Set to `false` to disable
|
||||
markComment: >
|
||||
This issue has been automatically marked as stale because it has not had
|
||||
recent activity. It will be closed if no further activity occurs. Thank you
|
||||
for your contributions.
|
||||
# Comment to post when closing a stale issue. Set to `false` to disable
|
||||
closeComment: false
|
||||
19
CHANGELOG.md
Normal file
19
CHANGELOG.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CHANGELOG
|
||||
|
||||
This is a manually generated log to track changes to the repository for each release.
|
||||
Each section should include general headers such as **Implemented enhancements**
|
||||
and **Merged pull requests**. All closed issued and bug fixes should be
|
||||
represented by the pull requests that fixed them. Critical items to know are:
|
||||
|
||||
- renamed commands
|
||||
- deprecated / removed commands
|
||||
- changed defaults
|
||||
- backward incompatible changes
|
||||
|
||||
|
||||
Versions correspond with GitHub releases that can be referenced with @ using actions.
|
||||
|
||||
## [master](https://github.com/vsoch/pull-request-action/tree/master) (master)
|
||||
- output and environment variables for PR number and return codes (1.0.5)
|
||||
- added support for reviewer (individual and team) assignments (1.0.4)
|
||||
- added support for maintainer can modify and assignees (1.0.3)
|
||||
@@ -7,8 +7,9 @@ LABEL "com.github.actions.description"="Create a pull request when a branch is c
|
||||
LABEL "com.github.actions.icon"="activity"
|
||||
LABEL "com.github.actions.color"="yellow"
|
||||
|
||||
RUN apk --no-cache add curl wget git bash jq
|
||||
COPY pull-request.sh /pull-request.sh
|
||||
RUN apk --no-cache add python3 py3-pip git bash && \
|
||||
pip3 install requests
|
||||
COPY pull-request.py /pull-request.py
|
||||
|
||||
RUN chmod u+x /pull-request.sh
|
||||
ENTRYPOINT ["/pull-request.sh"]
|
||||
RUN chmod u+x /pull-request.py
|
||||
ENTRYPOINT ["python3", "/pull-request.py"]
|
||||
|
||||
49
README.md
49
README.md
@@ -22,14 +22,14 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: pull-request-action
|
||||
uses: vsoch/pull-request-action@1.0.2
|
||||
uses: vsoch/pull-request-action@1.0.6
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH_PREFIX: "update/"
|
||||
PULL_REQUEST_BRANCH: "master"
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
## Environment Variable Inputs
|
||||
|
||||
Unlike standard actions, this action just uses variables from the environment.
|
||||
|
||||
@@ -39,14 +39,51 @@ Unlike standard actions, this action just uses variables from the environment.
|
||||
| PULL_REQUEST_BRANCH | open pull request against this branch | false | master |
|
||||
| PULL_REQUEST_FROM_BRANCH | if a branch isn't found in your GitHub payload, use this branch | false | |
|
||||
| PULL_REQUEST_BODY | the body for the pull request | false | |
|
||||
| PULL REQUEST_TITLE | the title for the pull request | false | |
|
||||
| PULL REQUEST_DRAFT | should this be a draft PR? | false | false |
|
||||
| PULL_REQUEST_TITLE | the title for the pull request | false | |
|
||||
| PULL_REQUEST_DRAFT | should this be a draft PR? | false | unset |
|
||||
| MAINTAINER_CANT_MODIFY | Do not allow the maintainer to modify the PR | false | unset |
|
||||
| PULL_REQUEST_ASSIGNEES | A list (string with spaces) of users to assign | false | unset |
|
||||
| PULL_REQUEST_REVIEWERS | A list (string with spaces) of users to assign review | false | unset |
|
||||
| PULL_REQUEST_TEAM_REVIEWERS | A list (string with spaces) of teams to assign review | false | unset |
|
||||
| PASS_ON_ERROR | Instead of failing on an error response, pass | unset |
|
||||
|
||||
All booleans should be lowercase.
|
||||
For `PULL_REQUEST_DRAFT`, `PASS_ON_ERROR`, and `MAINTAINER_CANT_MODIFY`, these are
|
||||
treated as environment booleans. If they are defined in the environment, they trigger the
|
||||
"true" condition. E.g.,:
|
||||
|
||||
- Define `MAINTAINER_CANT_MODIFY` if you don't want the maintainer to be able to modify the pull request.
|
||||
- Define `PULL_REQUEST_DRAFT` if you want the PR to be a draft.
|
||||
- Define `PASS_ON_ERROR` if you want the PR to not exit given any non 200/201 response.
|
||||
|
||||
For `PULL_REQUEST_ASSIGNEES`, `PULL_REQUEST_REVIEWERS`, and `PULL_REQUEST_TEAM_REVIEWERS`
|
||||
you can provide a string of one or more GitHub usernames (or team names) to
|
||||
assign to the issue. Note that only users with push access can add assigness to
|
||||
an issue or PR, they are ignored otherwise.
|
||||
|
||||
The `GITHUB_TOKEN` secret is required to interact and authenticate with the GitHub API to open
|
||||
the pull request. The example is [deployed here](https://github.com/vsoch/pull-request-action-example) with an example opened (and merged) [pull request here](https://github.com/vsoch/pull-request-action-example/pull/1) if needed.
|
||||
|
||||
## Outputs
|
||||
|
||||
The action sets a few useful output and environment variables. An output can
|
||||
be referenced later as `${{ steps.<stepname>.outputs.<output-name> }}`.
|
||||
An environment variable of course can be referenced as you usually would.
|
||||
|
||||
| Name | Description | Environment |
|
||||
|------|-------------|-------------|
|
||||
| pull_request_number |If the pull request is opened, this is the number for it. | PULL_REQUEST_NUMBER |
|
||||
| pull_request_url |If the pull request is opened, the html url for it. | PULL_REQUEST_URL |
|
||||
| pull_request_return_code | Return code for the pull request | PULL_REQUEST_RETURN_CODE |
|
||||
| assignees_return_code | Return code for the assignees request | ASSIGNEES_RETURN_CODE |
|
||||
| reviewers_return_code | Return code for the reviewers request | REVIEWERS_RETURN_CODE |
|
||||
|
||||
See the [examples/outputs-example.yml](examples/outputs-example.yml) for how this works.
|
||||
In this example, we can reference `${{ steps.pull_request.outputs.pull_request_url }}`
|
||||
in either another environment variable declaration, or within a run statement to access
|
||||
our variable `pull_request_url` that was generated in a step with id `pull_request`.
|
||||
The screenshot below shows the example in action to interact with outputs in several ways.
|
||||
|
||||

|
||||
|
||||
## Examples
|
||||
|
||||
@@ -72,7 +109,7 @@ jobs:
|
||||
PR_BRANCH_FROM=release-v$(cat VERSION)
|
||||
::set-env name=PULL_REQUEST_FROM_BRANCH::${PR_BRANCH_FROM}
|
||||
- name: pull-request-action
|
||||
uses: vsoch/pull-request-action@1.0.2
|
||||
uses: vsoch/pull-request-action@1.0.6
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PULL_REQUEST_BRANCH: "master"
|
||||
|
||||
11
action.yml
11
action.yml
@@ -7,3 +7,14 @@ runs:
|
||||
branding:
|
||||
icon: 'activity'
|
||||
color: 'yellow'
|
||||
outputs:
|
||||
pull_request_number:
|
||||
description: 'If the pull request is opened, this is the number for it.'
|
||||
pull_request_url:
|
||||
description: 'If the pull request is opened, the html url for it.'
|
||||
pull_request_return_code:
|
||||
description: 'The pull request return code.'
|
||||
assignees_return_code:
|
||||
description: 'The add assignees post return code.'
|
||||
reviewers_return_code:
|
||||
description: 'The add reviewers post return code.'
|
||||
|
||||
17
examples/assignees-example.yml
Normal file
17
examples/assignees-example.yml
Normal file
@@ -0,0 +1,17 @@
|
||||
name: Pull Request on Branch Push
|
||||
on:
|
||||
push:
|
||||
branches-ignore:
|
||||
- devel
|
||||
jobs:
|
||||
auto-pull-request:
|
||||
name: PullRequestAction
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: pull-request-action
|
||||
uses: vsoch/pull-request-action@1.0.3
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH_PREFIX: "update/"
|
||||
PULL_REQUEST_BRANCH: "master"
|
||||
PULL_REQUEST_ASSIGNEES: vsoch
|
||||
49
examples/branch-from-environment.yml
Normal file
49
examples/branch-from-environment.yml
Normal file
@@ -0,0 +1,49 @@
|
||||
name: derive-branch-from-environment
|
||||
|
||||
on:
|
||||
schedule:
|
||||
# Weekly
|
||||
- cron: 0 0 * * 0
|
||||
|
||||
jobs:
|
||||
DoSomeUpdate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v1
|
||||
- name: Install or Do Something to Change repository
|
||||
run: |
|
||||
echo "This is a new file." >> newfile.txt
|
||||
|
||||
- name: Checkout New Branch
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH_AGAINST: "master"
|
||||
run: |
|
||||
printf "GitHub Actor: ${GITHUB_ACTOR}\n"
|
||||
export BRANCH_FROM="update/newfile-$(date '+%Y-%m-%d')"
|
||||
git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
|
||||
git branch
|
||||
git checkout -b "${BRANCH_FROM}" || git checkout "${BRANCH_FROM}"
|
||||
git branch
|
||||
|
||||
git config --global user.name "github-actions"
|
||||
git config --global user.email "github-actions@users.noreply.github.com"
|
||||
|
||||
git add newfile.txt
|
||||
|
||||
if git diff-index --quiet HEAD --; then
|
||||
printf "No changes\n"
|
||||
else
|
||||
printf "Changes\n"
|
||||
git commit -m "Automated deployment to update software database $(date '+%Y-%m-%d')"
|
||||
git push origin "${BRANCH_FROM}"
|
||||
fi
|
||||
# Here is where we are setting the environment variable!
|
||||
echo "::set-env name=PULL_REQUEST_FROM_BRANCH::${BRANCH_FROM}"
|
||||
|
||||
- name: Open Pull Request
|
||||
uses: vsoch/pull-request-action@1.0.6
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PULL_REQUEST_BRANCH: "master"
|
||||
28
examples/outputs-example.yml
Normal file
28
examples/outputs-example.yml
Normal file
@@ -0,0 +1,28 @@
|
||||
name: Pull Request on Branch Push
|
||||
on:
|
||||
push:
|
||||
branches-ignore:
|
||||
- devel
|
||||
jobs:
|
||||
auto-pull-request:
|
||||
name: PullRequestAction
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: pull-request-action
|
||||
id: pull_request
|
||||
uses: vsoch/pull-request-action@1.0.6
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH_PREFIX: "update/"
|
||||
PULL_REQUEST_BRANCH: "master"
|
||||
PULL_REQUEST_REVIEWERS: vsoch
|
||||
- name: Test outputs
|
||||
env:
|
||||
pull_request_number_output: ${{ steps.pull_request.outputs.pull_request_number }}
|
||||
pull_request_url_output: ${{ steps.pull_request.outputs.pull_request_url }}
|
||||
run: |
|
||||
echo "Pull request number from output: ${pull_request_number_output}"
|
||||
echo "Pull request url from output: ${pull_request_url_output}"
|
||||
echo "Pull request number from environment: ${PULL_REQUEST_NUMBER}"
|
||||
echo "Pull request url from environment: ${PULL_REQUEST_URL}"
|
||||
echo "Another way to specify from output ${{ steps.pull_request.outputs.pull_request_number }}"
|
||||
17
examples/reviewers-example.yml
Normal file
17
examples/reviewers-example.yml
Normal file
@@ -0,0 +1,17 @@
|
||||
name: Pull Request on Branch Push
|
||||
on:
|
||||
push:
|
||||
branches-ignore:
|
||||
- devel
|
||||
jobs:
|
||||
auto-pull-request:
|
||||
name: PullRequestAction
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: pull-request-action
|
||||
uses: vsoch/pull-request-action@1.0.4
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH_PREFIX: "update/"
|
||||
PULL_REQUEST_BRANCH: "master"
|
||||
PULL_REQUEST_REVIEWERS: vsoch
|
||||
BIN
img/outputs.png
Normal file
BIN
img/outputs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
340
pull-request.py
Executable file
340
pull-request.py
Executable file
@@ -0,0 +1,340 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import sys
|
||||
import os
|
||||
import json
|
||||
import requests
|
||||
|
||||
################################################################################
|
||||
# Helper Functions
|
||||
################################################################################
|
||||
|
||||
|
||||
def get_envar(name):
|
||||
value = os.environ.get(name)
|
||||
if not value:
|
||||
sys.exit("%s is required for vsoch/pull-request-action" % name)
|
||||
return value
|
||||
|
||||
|
||||
def check_events_json():
|
||||
events = get_envar("GITHUB_EVENT_PATH")
|
||||
if not os.path.exists(events):
|
||||
sys.exit("Cannot find Github events file at ${GITHUB_EVENT_PATH}")
|
||||
print("Found ${GITHUB_EVENT_PATH} at %s" % events)
|
||||
return events
|
||||
|
||||
|
||||
def abort_if_fail(reason):
|
||||
"""If PASS_ON_ERROR, don't exit. Otherwise exit with an error and print the reason"""
|
||||
if os.environ.get("PASS_ON_ERROR"):
|
||||
print("Error, but PASS_ON_ERROR is set, continuing: %s" % reason)
|
||||
else:
|
||||
sys.exit(reason)
|
||||
|
||||
|
||||
def parse_into_list(values):
|
||||
if values:
|
||||
values = values.replace('"', "").replace("'", "")
|
||||
if not values:
|
||||
return []
|
||||
return [x.strip() for x in values.split(" ")]
|
||||
|
||||
|
||||
################################################################################
|
||||
# Global Variables (we can't use GITHUB_ prefix)
|
||||
################################################################################
|
||||
|
||||
API_VERSION = "v3"
|
||||
BASE = "https://api.github.com"
|
||||
|
||||
HEADERS = {
|
||||
"Authorization": "token %s" % get_envar("GITHUB_TOKEN"),
|
||||
"Accept": "application/vnd.github.%s+json;application/vnd.github.antiope-preview+json;application/vnd.github.shadow-cat-preview+json"
|
||||
% API_VERSION,
|
||||
}
|
||||
|
||||
# URLs
|
||||
REPO_URL = "%s/repos/%s" % (BASE, get_envar("GITHUB_REPOSITORY"))
|
||||
ISSUE_URL = "%s/issues" % REPO_URL
|
||||
PULLS_URL = "%s/pulls" % REPO_URL
|
||||
|
||||
|
||||
def create_pull_request(
|
||||
source,
|
||||
target,
|
||||
body,
|
||||
title,
|
||||
assignees,
|
||||
reviewers,
|
||||
team_reviewers,
|
||||
is_draft=False,
|
||||
can_modify=True,
|
||||
):
|
||||
|
||||
# Check if the branch already has a pull request open
|
||||
data = {"base": target, "head": source, "body": body}
|
||||
print("Data for checking if pull request exists: %s" % data)
|
||||
response = requests.get(PULLS_URL, json=data)
|
||||
|
||||
# Case 1: 404 might warrant needing a token
|
||||
if response.status_code == 404:
|
||||
response = requests.get(PULLS_URL, json=data, headers=HEADERS)
|
||||
if response.status_code != 200:
|
||||
abort_if_fail(
|
||||
"Unable to retrieve information about pull requests: %s: %s"
|
||||
% (response.status_code, response.reason)
|
||||
)
|
||||
|
||||
response = response.json()
|
||||
|
||||
# Option 1: The pull request is already open
|
||||
is_open = False
|
||||
if response:
|
||||
for entry in response:
|
||||
if entry.get("head", {}).get("ref", "") == source:
|
||||
print("Pull request from %s to %s is already open!" % (source, target))
|
||||
is_open = True
|
||||
|
||||
# Option 2: Open a new pull request
|
||||
if not is_open:
|
||||
print("%s does not have a pull request open, continuing!" % source)
|
||||
|
||||
# Post the pull request
|
||||
data = {
|
||||
"title": title,
|
||||
"body": body,
|
||||
"base": target,
|
||||
"head": source,
|
||||
"draft": is_draft,
|
||||
"maintainer_can_modify": can_modify,
|
||||
}
|
||||
print("Data for opening pull request: %s" % data)
|
||||
response = requests.post(PULLS_URL, json=data, headers=HEADERS)
|
||||
if response.status_code != 201:
|
||||
abort_if_fail(
|
||||
"Unable to create pull request: %s: %s, %s"
|
||||
% (
|
||||
response.status_code,
|
||||
response.reason,
|
||||
response.json().get("message", ""),
|
||||
)
|
||||
)
|
||||
|
||||
# Expected return codes are 0 for success
|
||||
pull_request_return_code = (
|
||||
0 if response.status_code == 201 else response.status_code
|
||||
)
|
||||
response = response.json()
|
||||
print("::group::github response")
|
||||
print(response)
|
||||
print("::endgroup::github response")
|
||||
number = response.get("number")
|
||||
html_url = response.get("html_url")
|
||||
print("Number opened for PR is %s" % number)
|
||||
print("::set-env name=PULL_REQUEST_NUMBER::%s" % number)
|
||||
print("::set-output name=pull_request_number::%s" % number)
|
||||
print("::set-env name=PULL_REQUEST_RETURN_CODE::%s" % pull_request_return_code)
|
||||
print(
|
||||
"::set-output name=pull_request_return_code::%s" % pull_request_return_code
|
||||
)
|
||||
print("::set-env name=PULL_REQUEST_URL::%s" % html_url)
|
||||
print("::set-output name=pull_request_url::%s" % html_url)
|
||||
|
||||
if assignees:
|
||||
|
||||
# Remove leading and trailing quotes
|
||||
assignees = parse_into_list(assignees)
|
||||
|
||||
print(
|
||||
"Attempting to assign %s to pull request with number %s"
|
||||
% (assignees, number)
|
||||
)
|
||||
|
||||
# POST /repos/:owner/:repo/issues/:issue_number/assignees
|
||||
data = {"assignees": assignees}
|
||||
ASSIGNEES_URL = "%s/%s/assignees" % (ISSUE_URL, number)
|
||||
response = requests.post(ASSIGNEES_URL, json=data, headers=HEADERS)
|
||||
if response.status_code != 201:
|
||||
abort_if_fail(
|
||||
"Unable to create assignees: %s: %s, %s"
|
||||
% (
|
||||
response.status_code,
|
||||
response.reason,
|
||||
response.json().get("message", ""),
|
||||
)
|
||||
)
|
||||
|
||||
assignees_return_code = (
|
||||
0 if response.status_code == 201 else response.status_code
|
||||
)
|
||||
print("::set-env name=ASSIGNEES_RETURN_CODE::%s" % assignees_return_code)
|
||||
print("::set-output name=assignees_return_code::%s" % assignees_return_code)
|
||||
|
||||
if reviewers or team_reviewers:
|
||||
|
||||
print(
|
||||
"Found reviewers: %s and team reviewers: %s"
|
||||
% (reviewers, team_reviewers)
|
||||
)
|
||||
team_reviewers = parse_into_list(team_reviewers)
|
||||
reviewers = parse_into_list(reviewers)
|
||||
print(
|
||||
"Parsed reviewers: %s and team reviewers: %s"
|
||||
% (reviewers, team_reviewers)
|
||||
)
|
||||
|
||||
# POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers
|
||||
REVIEWERS_URL = "%s/%s/requested_reviewers" % (PULLS_URL, number)
|
||||
|
||||
data = {"reviewers": reviewers, "team_reviewers": team_reviewers}
|
||||
response = requests.post(REVIEWERS_URL, json=data, headers=HEADERS)
|
||||
if response.status_code != 201:
|
||||
abort_if_fail(
|
||||
"Unable to assign reviewers: %s: %s, %s"
|
||||
% (
|
||||
response.status_code,
|
||||
response.reason,
|
||||
response.json().get("message", ""),
|
||||
)
|
||||
)
|
||||
|
||||
reviewers_return_code = (
|
||||
0 if response.status_code == 201 else response.status_code
|
||||
)
|
||||
response = response.json()
|
||||
print("::group::github reviewers response")
|
||||
print(response)
|
||||
print("::endgroup::github reviewers response")
|
||||
print("::set-env name=REVIEWERS_RETURN_CODE::%s" % reviewers_return_code)
|
||||
print("::set-output name=reviewers_return_code::%s" % reviewers_return_code)
|
||||
print("Add reviewers return code: %s" % reviewers_return_code)
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
# path to file that contains the POST response of the event
|
||||
# Example: https://github.com/actions/bin/tree/master/debug
|
||||
# Value: /github/workflow/event.json
|
||||
check_events_json()
|
||||
|
||||
branch_prefix = os.environ.get("BRANCH_PREFIX", "")
|
||||
print("Branch prefix is %s" % branch_prefix)
|
||||
if not branch_prefix:
|
||||
print("No branch prefix is set, all branches will be used.")
|
||||
|
||||
# Default to master to support older, will eventually change to main
|
||||
pull_request_branch = os.environ.get("PULL_REQUEST_BRANCH", "master")
|
||||
print("Pull requests will go to %s" % pull_request_branch)
|
||||
|
||||
# Pull request draft
|
||||
pull_request_draft = os.environ.get("PULL_REQUEST_DRAFT")
|
||||
if not pull_request_draft:
|
||||
print("No explicit preference for draft PR: created PRs will be normal PRs.")
|
||||
pull_request_draft = False
|
||||
else:
|
||||
print(
|
||||
"Environment variable PULL_REQUEST_DRAFT set to a value: created PRs will be draft PRs."
|
||||
)
|
||||
pull_request_draft = True
|
||||
|
||||
# Maintainer can modify, defaults to CAN, unless user sets MAINTAINER_CANT_MODIFY
|
||||
maintainer_can_modify = os.environ.get("MAINTAINER_CANT_MODIFY")
|
||||
if not maintainer_can_modify:
|
||||
print(
|
||||
"No explicit preference for maintainer being able to modify: default is true."
|
||||
)
|
||||
maintainer_can_modify = True
|
||||
else:
|
||||
print(
|
||||
"Environment variable MAINTAINER_CANT_MODIFY set to a value: maintainer will not be able to modify."
|
||||
)
|
||||
maintainer_can_modify = False
|
||||
|
||||
# Assignees
|
||||
assignees = os.environ.get("PULL_REQUEST_ASSIGNEES")
|
||||
if not assignees:
|
||||
print("PULL_REQUEST_ASSIGNEES is not set, no assignees.")
|
||||
else:
|
||||
print("PULL_REQUEST_ASSIGNEES is set, %s" % assignees)
|
||||
|
||||
# Reviewers (individual and team)
|
||||
|
||||
reviewers = os.environ.get("PULL_REQUEST_REVIEWERS")
|
||||
team_reviewers = os.environ.get("PULL_REQUEST_TEAM_REVIEWERS")
|
||||
if not reviewers:
|
||||
print("PULL_REQUEST_REVIEWERS is not set, no reviewers.")
|
||||
else:
|
||||
print("PULL_REQUEST_REVIEWERS is set, %s" % reviewers)
|
||||
|
||||
if not team_reviewers:
|
||||
print("PULL_REQUEST_TEAM_REVIEWERS is not set, no team reviewers.")
|
||||
else:
|
||||
print("PULL_REQUEST_TEAM_REVIEWERS is set, %s" % team_reviewers)
|
||||
|
||||
# The user is allowed to explicitly set the name of the branch
|
||||
from_branch = os.environ.get("PULL_REQUEST_FROM_BRANCH")
|
||||
if not from_branch:
|
||||
print("PULL_REQUEST_FROM_BRANCH is not set, checking branch in payload.")
|
||||
with open(check_events_json(), "r") as fd:
|
||||
from_branch = json.loads(fd.read()).get("ref")
|
||||
from_branch = from_branch.replace("refs/heads/", "").strip("/")
|
||||
else:
|
||||
print("PULL_REQUEST_FROM_BRANCH is set.")
|
||||
|
||||
# At this point, we must have a branch
|
||||
if from_branch:
|
||||
print("Found branch %s to open PR from" % from_branch)
|
||||
else:
|
||||
sys.exit(
|
||||
"No branch in payload, you are required to define PULL_REQUEST_FROM_BRANCH in the environment."
|
||||
)
|
||||
|
||||
# If it's to the target branch, ignore it
|
||||
|
||||
if from_branch == pull_request_branch:
|
||||
print("Target and current branch are identical (%s), skipping." % from_branch)
|
||||
else:
|
||||
|
||||
# If the prefix for the branch matches
|
||||
if not branch_prefix or from_branch.startswith(branch_prefix):
|
||||
|
||||
# Pull request body (optional)
|
||||
pull_request_body = os.environ.get(
|
||||
"PULL_REQUEST_BODY",
|
||||
"This is an automated pull request to update from branch %s"
|
||||
% from_branch,
|
||||
)
|
||||
|
||||
print("::group::pull request body")
|
||||
print(pull_request_body)
|
||||
print("::endgroup::pull request body")
|
||||
|
||||
# Pull request title (optional)
|
||||
pull_request_title = os.environ.get(
|
||||
"PULL_REQUEST_TITLE", "Update from %s" % from_branch
|
||||
)
|
||||
print("::group::pull request title")
|
||||
print(pull_request_title)
|
||||
print("::endgroup::pull request title")
|
||||
|
||||
# Create the pull request
|
||||
create_pull_request(
|
||||
target=pull_request_branch,
|
||||
source=from_branch,
|
||||
body=pull_request_body,
|
||||
title=pull_request_title,
|
||||
is_draft=pull_request_draft,
|
||||
can_modify=maintainer_can_modify,
|
||||
assignees=assignees,
|
||||
reviewers=reviewers,
|
||||
team_reviewers=team_reviewers,
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
print("==========================================================================")
|
||||
print("START: Running Pull Request on Branch Update Action!")
|
||||
main()
|
||||
print("==========================================================================")
|
||||
print("END: Finished")
|
||||
163
pull-request.sh
163
pull-request.sh
@@ -1,163 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Suggested by Github actions to be strict
|
||||
set -e
|
||||
set -o pipefail
|
||||
|
||||
################################################################################
|
||||
# Global Variables (we can't use GITHUB_ prefix)
|
||||
################################################################################
|
||||
|
||||
API_VERSION=v3
|
||||
BASE=https://api.github.com
|
||||
AUTH_HEADER="Authorization: token ${GITHUB_TOKEN}"
|
||||
HEADER="Accept: application/vnd.github.${API_VERSION}+json"
|
||||
HEADER="${HEADER}; application/vnd.github.antiope-preview+json; application/vnd.github.shadow-cat-preview+json"
|
||||
|
||||
# URLs
|
||||
REPO_URL="${BASE}/repos/${GITHUB_REPOSITORY}"
|
||||
PULLS_URL=$REPO_URL/pulls
|
||||
|
||||
################################################################################
|
||||
# Helper Functions
|
||||
################################################################################
|
||||
|
||||
|
||||
check_credentials() {
|
||||
|
||||
if [[ -z "${GITHUB_TOKEN}" ]]; then
|
||||
printf "You must include the GITHUB_TOKEN as an environment variable.\n"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
}
|
||||
|
||||
check_events_json() {
|
||||
|
||||
if [[ ! -f "${GITHUB_EVENT_PATH}" ]]; then
|
||||
printf "Cannot find Github events file at ${GITHUB_EVENT_PATH}\n";
|
||||
exit 1;
|
||||
fi
|
||||
printf "Found ${GITHUB_EVENT_PATH}\n";
|
||||
|
||||
}
|
||||
|
||||
create_pull_request() {
|
||||
|
||||
# JSON strings
|
||||
SOURCE="$(echo -n "${1}" | jq --raw-input --slurp ".")" # from this branch
|
||||
TARGET="$(echo -n "${2}" | jq --raw-input --slurp ".")" # pull request TO this target
|
||||
BODY="$(echo -n "${3}" | jq --raw-input --slurp ".")" # this is the content of the message
|
||||
TITLE="$(echo -n "${4}" | jq --raw-input --slurp ".")" # pull request title
|
||||
|
||||
# JSON boolean
|
||||
if [[ "${5}" == "true" ]]; then # if PRs are draft
|
||||
DRAFT="true";
|
||||
else
|
||||
DRAFT="false";
|
||||
fi
|
||||
|
||||
# Check if the branch already has a pull request open
|
||||
|
||||
DATA="{\"base\":${TARGET}, \"head\":${SOURCE}, \"body\":${BODY}}"
|
||||
RESPONSE=$(curl -sSL -H "${AUTH_HEADER}" -H "${HEADER}" --user "${GITHUB_ACTOR}" -X GET --data "${DATA}" ${PULLS_URL})
|
||||
PR=$(echo "${RESPONSE}" | jq --raw-output '.[] | .head.ref')
|
||||
printf "Response ref: ${PR}\n"
|
||||
|
||||
# Option 1: The pull request is already open
|
||||
if [[ "${PR}" == "${SOURCE}" ]]; then
|
||||
printf "Pull request from ${SOURCE} to ${TARGET} is already open!\n"
|
||||
|
||||
# Option 2: Open a new pull request
|
||||
else
|
||||
# Post the pull request
|
||||
DATA="{\"title\":${TITLE}, \"body\":${BODY}, \"base\":${TARGET}, \"head\":${SOURCE}, \"draft\":${DRAFT}}"
|
||||
printf "curl --user ${GITHUB_ACTOR} -X POST --data ${DATA} ${PULLS_URL}\n"
|
||||
curl -sSL -H "${AUTH_HEADER}" -H "${HEADER}" --user "${GITHUB_ACTOR}" -X POST --data "${DATA}" ${PULLS_URL}
|
||||
echo $?
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
main () {
|
||||
|
||||
# path to file that contains the POST response of the event
|
||||
# Example: https://github.com/actions/bin/tree/master/debug
|
||||
# Value: /github/workflow/event.json
|
||||
check_events_json;
|
||||
|
||||
# User specified branch to PR to, and check
|
||||
if [ -z "${BRANCH_PREFIX}" ]; then
|
||||
printf "No branch prefix is set, all branches will be used.\n"
|
||||
BRANCH_PREFIX=""
|
||||
printf "Branch prefix is $BRANCH_PREFIX\n"
|
||||
fi
|
||||
|
||||
if [ -z "${PULL_REQUEST_BRANCH}" ]; then
|
||||
PULL_REQUEST_BRANCH=master
|
||||
fi
|
||||
printf "Pull requests will go to ${PULL_REQUEST_BRANCH}\n"
|
||||
|
||||
if [ -z "${PULL_REQUEST_DRAFT}" ]; then
|
||||
printf "No explicit preference for draft PR: created PRs will be normal PRs.\n"
|
||||
PULL_REQUEST_DRAFT="false"
|
||||
else
|
||||
printf "Environment variable PULL_REQUEST_DRAFT set to a value: created PRs will be draft PRs.\n"
|
||||
PULL_REQUEST_DRAFT="true"
|
||||
fi
|
||||
|
||||
# The user is allowed to explicitly set the name of the branch
|
||||
if [ -z "${PULL_REQUEST_FROM_BRANCH}" ]; then
|
||||
printf "PULL_REQUEST_FROM_BRANCH is not set, checking branch in payload.\n"
|
||||
BRANCH=$(jq --raw-output .ref "${GITHUB_EVENT_PATH}");
|
||||
BRANCH=$(echo "${BRANCH/refs\/heads\//}")
|
||||
else
|
||||
printf "PULL_REQUEST_FROM_BRANCH is set.\n"
|
||||
BRANCH="${PULL_REQUEST_FROM_BRANCH}"
|
||||
fi
|
||||
|
||||
# At this point, we must have a branch
|
||||
if [[ "$BRANCH" != "null" ]]; then
|
||||
printf "Found branch $BRANCH to open PR from\n"
|
||||
else
|
||||
printf "No branch in payload, you are required to define PULL_REQUEST_FROM_BRANCH in the environment.\n"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# If it's to the target branch, ignore it
|
||||
if [[ "${BRANCH}" == "${PULL_REQUEST_BRANCH}" ]]; then
|
||||
printf "Target and current branch are identical (${BRANCH}), skipping.\n"
|
||||
else
|
||||
|
||||
# If the prefix for the branch matches
|
||||
if [[ $BRANCH == ${BRANCH_PREFIX}* ]]; then
|
||||
|
||||
# Ensure we have a GitHub token
|
||||
check_credentials
|
||||
|
||||
# Pull request body (optional)
|
||||
if [ -z "${PULL_REQUEST_BODY}" ]; then
|
||||
echo "No pull request body is set, will use default."
|
||||
PULL_REQUEST_BODY="This is an automated pull request to update the container collection ${BRANCH}"
|
||||
fi
|
||||
printf "Pull request body is ${PULL_REQUEST_BODY}\n"
|
||||
|
||||
# Pull request title (optional)
|
||||
if [ -z "${PULL_REQUEST_TITLE}" ]; then
|
||||
printf "No pull request title is set, will use default.\n"
|
||||
PULL_REQUEST_TITLE="Update container ${BRANCH}"
|
||||
fi
|
||||
printf "Pull request title is ${PULL_REQUEST_TITLE}\n"
|
||||
|
||||
create_pull_request "${BRANCH}" "${PULL_REQUEST_BRANCH}" "${PULL_REQUEST_BODY}" "${PULL_REQUEST_TITLE}" "${PULL_REQUEST_DRAFT}"
|
||||
|
||||
fi
|
||||
|
||||
fi
|
||||
}
|
||||
|
||||
echo "==========================================================================
|
||||
START: Running Pull Request on Branch Update Action!";
|
||||
main;
|
||||
echo "==========================================================================
|
||||
END: Finished";
|
||||
Reference in New Issue
Block a user