GitHub

Available as of Camel 2.15

The GitHub component interacts with the GitHub API by encapsulating egit-github. It currently provides polling for new pull requests, pull request comments, tags, and commits.  It is also able to produce comments on pull requests, as well as close the pull request entirely.

Rather than webhooks, this endpoint relies on simple polling. Reasons include:

  • Concern for reliability/stability
  • The types of payloads we're polling aren't typically large (plus, paging is available in the API)
  • The need to support apps running somewhere not publicly accessible where a webhook would fail

Note that the GitHub API is fairly expansive.  Therefore, this component could be easily expanded to provide additional interactions.

Maven users will need to add the following dependency to their pom.xml for this component:

URI format

Mandatory Options:

Note that these can be configured directly through the endpoint.

Option

Description

username

GitHub username, required unless oauthToken is provided

password

GitHub password, required unless oauthToken is provided

oauthToken

GitHub OAuth token, required unless username & password are provided

repoOwner

GitHub repository owner (organization)

repoNameGitHub repository name

Consumer Endpoints:

Endpoint

Context

Body Type

pullRequest

polling

org.eclipse.egit.github.core.PullRequest

pullRequestComment

polling

org.eclipse.egit.github.core.Comment (comment on the general pull request discussion) or org.eclipse.egit.github.core.CommitComment (inline comment on a pull request diff)

tag

polling

org.eclipse.egit.github.core.RepositoryTag

commit

polling

org.eclipse.egit.github.core.RepositoryCommit

Producer Endpoints:

Endpoint

Body

Message Headers

pullRequestComment

String (comment text)

  • GitHubPullRequest (integer) (REQUIRED): Pull request number.
  • GitHubInResponseTo (integer): Required if responding to another inline comment on the pull request diff. If left off, a general comment on the pull request discussion is assumed.

closePullRequest

none

  • GitHubPullRequest (integer) (REQUIRED): Pull request number.

createIssue (From Camel 2.18)

String (issue body text)

  • GitHubIssueTitle (String) (REQUIRED): Issue Title.

URI Options

Name

Default Value

Description

delay

60

in seconds

© 2004-2015 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram