This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • GitHub
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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.

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>

URI format

gihub://endpoint[?options]

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.

URI Options

Name

Default Value

Description

delay

60

in seconds

  • No labels