PullRequestFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)
PullRequestFilter contains filter properties for matching GitHub Pull Requests.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
---|---|
Name | Description |
branch |
str
Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax This field is a member of oneof _ git_ref .
|
comment_control |
google.cloud.devtools.cloudbuild_v1.types.PullRequestFilter.CommentControl
If CommentControl is enabled, depending on the setting, builds may not fire until a repository writer comments /gcbrun on a pull request or /gcbrun is in the pull
request description. Only PR comments that contain
/gcbrun will trigger builds.
If CommentControl is set to disabled, comments with
/gcbrun from a user with repository write permission or
above will still trigger builds to run.
|
invert_regex |
bool
If true, branches that do NOT match the git_ref will trigger a build. |
Classes
CommentControl
CommentControl(value)
Controls whether or not a /gcbrun
comment is required from a
user with repository write permission or above in order to trigger
Build runs for pull requests. Pull Request update events differ
between repo types. Check repo specific guides
(GitHub <https://cloud.google.com/build/docs/automating-builds/github/build-repos-from-github-enterprise#creating_a_github_enterprise_trigger>
,
Bitbucket <https://cloud.google.com/build/docs/automating-builds/bitbucket/build-repos-from-bitbucket-server#creating_a_bitbucket_server_trigger>
,
GitLab <https://cloud.google.com/build/docs/automating-builds/gitlab/build-repos-from-gitlab#creating_a_gitlab_trigger>
__
for details.
1. The pull request author has repository write permission
or above and `/gcbrun` is in the PR description.
2. A user with repository writer permissions or above
comments `/gcbrun` on a pull request authored by any
user.
COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY (2):
Builds will only fire in response to pull requests if:
1. The pull request author is a repository writer or above.
2. If the author does not have write permissions, a user
with write permissions or above must comment `/gcbrun`
in order to fire a build.