Skip to content

Commit

Permalink
rendering tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
timja committed Apr 16, 2020
1 parent 34325ef commit 1e7c216
Showing 1 changed file with 3 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This has been a long awaited feature by many users.

It has been released in link:https://github.com/jenkinsci/github-branch-source-plugin/releases/tag/github-branch-source-2.7.0-beta1[GitHub Branch Source 2.7.0-beta1] which is available in the link:/doc/developer/publishing/releasing-experimental-updates/#using-the-experimental-update-center[Jenkins experimental update center].

Authenticating as a GitHub app brings many benefits:
Authenticating as a GitHub app brings many benefits:

* **Larger rate limits** - The rate limit for a GitHub app scales with your organization size,
whereas a user based token has a limit of 5000 regardless of how many repositories you have.
Expand Down Expand Up @@ -44,13 +44,13 @@ image:/images/github-app-rate-limit.png[GitHub app rate limit]

== How do I get an API token in my pipeline?

In addition to usage of GitHub App authentication for Multi-Branch Pipeline, you can also app authentication directly in your Pipelines.
In addition to usage of GitHub App authentication for Multi-Branch Pipeline, you can also use app authentication directly in your Pipelines.
You can access the Bearer token for the GitHub API by just loading a 'Username/Password' credential as usual,
the plugin will handle authenticating with GitHub in the background.

This could be used to call additional GitHub API endpoints from your pipeline, possibly the
link:https://developer.github.com/v3/repos/deployments/[deployments api] or you may wish to implement your own
links:https://developer.github.com/v3/checks/[checks api] integration until Jenkins supports this out of the box.
link:https://developer.github.com/v3/checks/[checks api] integration until Jenkins supports this out of the box.

_Note: the API token you get will only be valid for one hour, don't get it at the start of the pipeline and assume it will be valid all the way through_

Expand Down Expand Up @@ -93,7 +93,6 @@ pipeline {
== What's next

GitHub Apps authentication in Jenkins is a huge improvement. Many teams have already started using it and have helped improve it by giving pre-release feedback. There are more improvements on the way.
I hope that the feature will be released shortly in the main Jenkins update center once they are released.

There's a proposed Google Summer of Code project: link:https://jenkins.io/projects/gsoc/2020/project-ideas/github-checks/[GitHub Checks API for Jenkins Plugins].
It will look at integrating with the link:https://developer.github.com/v3/checks/[Checks API],
Expand Down

0 comments on commit 1e7c216

Please sign in to comment.