Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
58a078aed9 | ||
|
|
408336c607 | ||
|
|
d99aa3ed71 | ||
|
|
a48b660567 | ||
|
|
4b09070b0a | ||
|
|
29dbfc0acd | ||
|
|
c0bf76830b | ||
|
|
1cb1956a68 |
@@ -14,6 +14,7 @@ represented by the pull requests that fixed them. Critical items to know are:
|
||||
Versions correspond with GitHub releases that can be referenced with @ using actions.
|
||||
|
||||
## [master](https://github.com/vsoch/pull-request-action/tree/master) (master)
|
||||
- bugfix of writing to environment file (missing newline) (1.0.19)
|
||||
- bugfix of missing from branch with scheduled run (1.0.16)
|
||||
- forgot to add assignees (1.0.15)
|
||||
- output and environment variables for PR number and return codes (1.0.5)
|
||||
|
||||
12
README.md
12
README.md
@@ -39,6 +39,8 @@ Unlike standard actions, this action just uses variables from the environment.
|
||||
| Name | Description | Required | Default |
|
||||
|------|-------------|----------|---------|
|
||||
| BRANCH_PREFIX | the prefix to filter to. If the branch doesn't start with the prefix, it will be ignored | false | "" |
|
||||
| PULL_REQUEST_REPOSITORY | Choose another repository instead of default GITHUB_REPOSITORY for the PR | false | |
|
||||
| PULL_REQUEST_TOKEN | [Personal Access Token(PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) only if you define a different repository with PULL_REQUEST_REPOSITORY | false | |
|
||||
| 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 | |
|
||||
@@ -48,10 +50,10 @@ Unlike standard actions, this action just uses variables from the environment.
|
||||
| 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 |
|
||||
| PASS_IF_EXISTS | Instead of failing if the pull request already exists, pass | unset |
|
||||
| PULL_REQUEST_UPDATE | If the pull request already exists, update it | unset |
|
||||
| PULL_REQUEST_STATE | If `PULL_REQUEST_UPDATE` is true, update to this state (open, closed) | open |
|
||||
| PASS_ON_ERROR | Instead of failing on an error response, pass | false | unset |
|
||||
| PASS_IF_EXISTS | Instead of failing if the pull request already exists, pass | false | unset |
|
||||
| PULL_REQUEST_UPDATE | If the pull request already exists, update it | false | unset |
|
||||
| PULL_REQUEST_STATE | If `PULL_REQUEST_UPDATE` is true, update to this state (open, closed) | false |open |
|
||||
|
||||
For `PULL_REQUEST_DRAFT`, `PASS_ON_ERROR`, `PASS_IF_EXISTS`, and `MAINTAINER_CANT_MODIFY`, these are
|
||||
treated as environment booleans. If they are defined in the environment, they trigger the
|
||||
@@ -71,6 +73,8 @@ 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.
|
||||
|
||||
If you want to create a pull request to another repository, for example, a pull request to the upstream repository, you need to define PULL_REQUEST_REPOSITORY and PULL_REQUEST_TOKEN. The PULL_REQUEST_TOKEN is one [Personal Access Token(PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token), which can be save in the [encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
|
||||
|
||||
## Outputs
|
||||
|
||||
The action sets a few useful output and environment variables. An output can
|
||||
|
||||
BIN
img/open-source-halloween-2021.png
Normal file
BIN
img/open-source-halloween-2021.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
@@ -79,7 +79,7 @@ def set_env(name, value):
|
||||
environment_file_path = os.environ.get("GITHUB_ENV")
|
||||
|
||||
with open(environment_file_path, "a") as environment_file:
|
||||
environment_file.write("%s=%s" % (name, value))
|
||||
environment_file.write("%s=%s\n" % (name, value))
|
||||
|
||||
|
||||
def open_pull_request(title, body, target, source, is_draft=False, can_modify=True):
|
||||
@@ -108,6 +108,7 @@ def open_pull_request(title, body, target, source, is_draft=False, can_modify=Tr
|
||||
print("Data for opening pull request: %s" % data)
|
||||
response = requests.post(PULLS_URL, json=data, headers=HEADERS)
|
||||
if response.status_code != 201:
|
||||
print(f"pull request url is {PULLS_URL}")
|
||||
abort_if_fail(response, "Unable to create pull request")
|
||||
|
||||
return response
|
||||
@@ -233,6 +234,21 @@ def find_pull_request(listing, source):
|
||||
return entry
|
||||
|
||||
|
||||
def find_default_branch():
|
||||
"""Find default branch for a repo (only called if branch not provided)"""
|
||||
response = requests.get(REPO_URL)
|
||||
|
||||
# Case 1: 404 might need a token
|
||||
if response.status_code == 404:
|
||||
response = requests.get(REPO_URL, headers=HEADERS)
|
||||
if response.status_code != 200:
|
||||
abort_if_fail(response, "Unable to retrieve default branch")
|
||||
|
||||
default_branch = response.json()["default_branch"]
|
||||
print("Found default branch: %s" % default_branch)
|
||||
return default_branch
|
||||
|
||||
|
||||
def add_reviewers(entry, reviewers, team_reviewers):
|
||||
"""Given regular or team reviewers, add them to a PR.
|
||||
|
||||
@@ -266,16 +282,21 @@ def add_reviewers(entry, reviewers, team_reviewers):
|
||||
################################################################################
|
||||
|
||||
API_VERSION = "v3"
|
||||
BASE = "https://api.github.com"
|
||||
|
||||
# Allow for a GitHub enterprise URL
|
||||
BASE = os.environ.get("GITHUB_API_URL") or "https://api.github.com"
|
||||
|
||||
PR_TOKEN = os.environ.get("PULL_REQUEST_TOKEN") or get_envar("GITHUB_TOKEN")
|
||||
PR_REPO = os.environ.get("PULL_REQUEST_REPOSITORY") or get_envar("GITHUB_REPOSITORY")
|
||||
|
||||
HEADERS = {
|
||||
"Authorization": "token %s" % get_envar("GITHUB_TOKEN"),
|
||||
"Authorization": "token %s" % PR_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"))
|
||||
REPO_URL = "%s/repos/%s" % (BASE, PR_REPO)
|
||||
ISSUE_URL = "%s/issues" % REPO_URL
|
||||
PULLS_URL = "%s/pulls" % REPO_URL
|
||||
|
||||
@@ -339,8 +360,8 @@ def main():
|
||||
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")
|
||||
# Default to project default branch if none provided
|
||||
pull_request_branch = os.environ.get("PULL_REQUEST_BRANCH", find_default_branch())
|
||||
print("Pull requests will go to %s" % pull_request_branch)
|
||||
|
||||
# Pull request draft
|
||||
|
||||
Reference in New Issue
Block a user