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.
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:
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-github</artifactId> <version>${camel-version}</version> </dependency> |
gihub://endpoint[?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) |
repoName | GitHub repository name |
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 |
Endpoint | Body Type | Message Headers |
---|---|---|
pullRequestComment | String |
|
closePullRequest | none |
|
Name | Default Value | Description |
---|---|---|
delay |
| in seconds |