ghprb-plugin | github pull requests builder plugin for Jenkins | Bot library

by jenkinsci Java Version: ghprb-1.42.2 License: MIT

X-Ray Key Features Code Snippets Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | ghprb-plugin Summary

ghprb-plugin is a Java library typically used in Automation, Bot, Jenkin applications. ghprb-plugin has no bugs, it has no vulnerabilities, it has build file available, it has a Permissive License and it has low support. You can download it from GitHub.

github pull requests builder plugin for Jenkins

Support

Quality

Security

License

Reuse

Support

ghprb-plugin has a low active ecosystem.

It has 496 star(s) with 616 fork(s). There are 19 watchers for this library.

It had no major release in the last 6 months.

There are 164 open issues and 303 have been closed. On average issues are closed in 149 days. There are 37 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of ghprb-plugin is ghprb-1.42.2

Quality

ghprb-plugin has 0 bugs and 0 code smells.

Security

ghprb-plugin has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

ghprb-plugin code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

ghprb-plugin is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

ghprb-plugin releases are not available. You will need to build from source code and install.

Build file is available. You can build the component from source.

Installation instructions, examples and code snippets are available.

ghprb-plugin saves you 4257 person hours of effort in developing the same functionality from scratch.

It has 9030 lines of code, 686 functions and 118 files.

It has medium code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed ghprb-plugin and discovered the below as its top functions. This is intended to give you an instant insight into ghprb-plugin implemented functionality, and help decide if they suit your requirements.

Index the event
Handle the issue comment
Checks if the signature matches the expected external signature
Gets the triggers matching the specified signature
Perform merge
Returns true if the given PR is the same as the given author
Deletes a branch
Resolves the comment file
Gets the environment variables for a specific build
Called when the build commit status is completed
Sets up the status of the job
Stop the job
Runs the trigger
Evaluate the cause
Returns a list of extensions that match the given types
Creates a set from a list of strings
Checks if a specific PR contains a comment with the given expected body
Creates a web hook
Trigger a pull request
Triggers a comment
Calculate the build URL of the build
Return the aggregated results of a build
Appends the comment to the commit log
Returns the default value of the named method
Called when a build is triggered
Starts the trigger

Get all kandi verified functions for this library.

ghprb-plugin Key Features

No Key Features are available at this moment for ghprb-plugin.

ghprb-plugin Examples and Code Snippets

No Code Snippets are available at this moment for ghprb-plugin.

Community Discussions

Trending Discussions on ghprb-plugin

How to configure Jenkins GitHubPullRequestBuilder plugin using Job DSL

QUESTION

How to configure Jenkins GitHubPullRequestBuilder plugin using Job DSL

Asked 2020-Aug-13 at 20:29

I am setting up webhook integration between a private GitHub repository and a Jenkins build. I configure jobs exclusively using Job DSL groovy scripts (I'm open to switching to another programmatic job configuration mechanism, but I will not accept any answer that requires me to configure jobs manually). II would like to set up a commit status context and a set of custom messages based on build status.

The Job DSL API documentation embedded in Jenkins is not helpful, only giving me this signature: githubPullRequest(Closure closure), but not telling me how to construct a suitable closure.

Here are the relevant sections of my job DSL:

...

ANSWER

Answered 2020-Aug-13 at 20:29

Got it figured. There were several issues, but the crux of the problem was authentication: the various plugins and components accept and require different types of credentials. The setup I have working for me now uses a combination of personal access tokens and SSH keypairs to authenticate to GitHub.

Here's how to set up authentication:

Generate a new public-private keypair. I did this on my local machine, but you can do it anywhere. The private key file's contents will provide access to your GitHub account, so use appropriate caution when you decide where to keep the file, and clean up after yourself accordingly.
Go to GitHub and log in as the user you want Jenkins to use to authenticate to GitHub.
Navigate to Settings -> SSH and GPG keys. (Note: that's the user's settings, not a repo's settings)
Create a new SSH key. Give it a name (I named mine after the Jenkins instance) and paste in the contents of the public key generated in step 1.
Navigate to Settings -> Developer settings -> Personal access tokens
Generate a new token. Grant it access to "repo". Make sure you capture the token value somewhere safe -- I saved mine in my password manager. If you lose it, you'll have to go through all of these steps again to make a new one and configure Jenkins to use it.
- My company uses a private GitHub org with SAML-based auth and SSO. If this is true for you as well, make sure you enable SSO on the token for the appropriate org(s).
In Jenkins, go to Manage Jenkins -> Manage Credentials.
Create a new "SSH Username with private key" credential in the System / Global domain. In the "Username" field, enter the GitHub username. For the private key, choose "Enter directly", choose "Add", and paste in the text contents of the private key file generated in step 1.
- You'll give the credential an ID and a description as part of creating it. The ID is used in XML config files, and the description is used in the Jenkins configuration UI. I like to use the same value for both so that the value stored in the XML config files is the same as the value I see in the user interface. IDs can be uppercase and lowercase letters plus separator characters. For best readability, i-like-to-use-kebab-case.
Create a new "Secret Text" credential in the System / Global domain. In the "Secret" field, enter the token value GitHub generated in step 6. Again, give it a description and an ID.
In Manage Jenkins -> Configure System -> GitHub Pull Request Builder -> Credentials, choose the token-based credential you created in step 9.

Here's the Job DSL that worked for PRs, using the jenkins-ghprb plugin:

Source https://stackoverflow.com/questions/63253159

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install ghprb-plugin

You can download it from GitHub.
You can use ghprb-plugin like any standard Java library. Please include the the jar files in your classpath. You can also use any IDE and you can run and debug the ghprb-plugin component as you would do with any other Java program. Best practice is to use a build tool that supports dependency management such as Maven or Gradle. For Maven installation, please refer maven.apache.org. For Gradle installation, please refer gradle.org .

Support

Since the plugin contains an extension for the Job DSL plugin to add DSL syntax for configuring the build trigger and the pull request merger post-build action. It is also possible to set Downstream job commit statuses when displayBuildErrorsOnDownstreamBuilds() is set in the upstream job's triggers and downstreamCommitStatus block is included in the downstream job's wrappers.

Find more information at: