Utility class for internally hosted GitHub Enterprise interaction
Type | Name and description |
---|---|
static java.util.Map |
ghPrConfigDefaults |
Type Params | Return Type | Name and description |
---|---|---|
|
static void |
ghPrWatcher(java.lang.Object context, java.util.Map ghPrConfig) Utility method to watch a GitHub Enterprise or GitHub.com project and trigger on PR creation. |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Utility method to watch a GitHub Enterprise or GitHub.com project and trigger on PR creation.
This is a wrapper for the GitHub Pull Request Builder Plugin.
context
- delegateghPrConfig
- A Map
of configuration for the PR builder.
Valid keys:
ghProject
The GitHub project name, e.g. username/reponame
ghHostname
The GitHub hostname, i.e. github.org.tld,
or github.com
ghAuthId
the Jenkins credential ID for GitHub authentication
see the plugin docs
ghPermitAll
optional Whether or not to allow all
contributors to build a PR. Defaults to false.
ghPrHooks
optional Whether or not to install webhooks
in the remote repo. Defaults to true.
ghPrCron
optional For use when ghPrHooks is false.
Uses standard cron syntax.
ghPrOrgList
optional A string of organizations to whitelist for
PRs. Defaults to 'jenkins'.
ghPrStatusContext
optional A context for this job's tests as it
will appear on PR issues in GH's UI. Defaults to 'Tests from GitHub PR Builder.'
ghPrResultMessage
optional A Map
whose keys are the build
result (SUCCESS, FAILURE, or ERROR) and value is the message posted to GH as a result.