GitHub

GitHub

Scheme: github

The endpoint encapsulates portions of the GitHub API, relying on the org.eclipse.egit.github.core Java SDK. Available endpoint URIs include: CONSUMERS github://pullRequest (new pull requests) github://pullRequestComment (new pull request comments) github://commit/[branch] (new commits) github://tag (new tags) PRODUCERS github://pullRequestComment (create a new pull request comment; see PullRequestCommentProducer for header requirements) The endpoints will respond with org.eclipse.egit.github.core-provided POJOs (PullRequest, CommitComment, RepositoryTag, RepositoryCommit, etc.) Note: Rather than webhooks, this endpoint relies on simple polling. Reasons include: - concerned about reliability/stability if this somehow relied on an exposed, embedded server (Jetty?) - the types of payloads we're polling aren't typically large (plus, paging is available in the API) - need to support apps running somewhere not publicly accessible where a webhook would fail

Name Kind Type Required Deprecated Default Value Enum Values Description
type path org.apache.camel.component.github.GitHubType true false CLOSEPULLREQUEST
PULLREQUESTCOMMENT
COMMIT
PULLREQUEST
TAG
PULLREQUESTSTATE
PULLREQUESTFILES
GETCOMMITFILE
What git operation to execute
branchName path java.lang.String false Name of branch
username parameter java.lang.String false GitHub username, required unless oauthToken is provided
password parameter java.lang.String false GitHub password, required unless oauthToken is provided
oauthToken parameter java.lang.String false GitHub OAuth token, required unless username & password are provided
repoOwner parameter java.lang.String true false GitHub repository owner (organization)
repoName parameter java.lang.String true false GitHub repository name
state parameter java.lang.String false error
failure
pending
success
To set git commit status state
targetUrl parameter java.lang.String false To set git commit status target url
encoding parameter java.lang.String false To use the given encoding when getting a git commit file
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).