camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-github docs to gitbook
Date Fri, 01 Apr 2016 14:46:15 GMT
Repository: camel
Updated Branches:
  refs/heads/master b314abf55 -> 61e192d09


Added camel-github docs to gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/61e192d0
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/61e192d0
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/61e192d0

Branch: refs/heads/master
Commit: 61e192d09546aed8751d6190bc50c21521d33c0f
Parents: b314abf
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Fri Apr 1 16:44:49 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Fri Apr 1 16:44:49 2016 +0200

----------------------------------------------------------------------
 .../camel-github/src/main/docs/github.adoc      | 116 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 2 files changed, 117 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/61e192d0/components/camel-github/src/main/docs/github.adoc
----------------------------------------------------------------------
diff --git a/components/camel-github/src/main/docs/github.adoc b/components/camel-github/src/main/docs/github.adoc
new file mode 100644
index 0000000..f90a3ef
--- /dev/null
+++ b/components/camel-github/src/main/docs/github.adoc
@@ -0,0 +1,116 @@
+[[GitHub-GitHub]]
+GitHub
+~~~~~~
+
+*Available as of Camel 2.15*
+
+The GitHub component interacts with the GitHub API by
+encapsulating http://org.eclipse.egit.github.core[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:
+
+[source,xml]
+-----------------------------------------
+<dependency>
+    <groupId>org.apache.camel</groupId>
+    <artifactId>camel-github</artifactId>
+    <version>${camel-version}</version>
+</dependency>
+-----------------------------------------
+
+[[GitHub-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,text]
+---------------------------
+github://endpoint[?options]
+---------------------------
+
+[[GitHub-MandatoryOptions:]]
+Mandatory Options:
+^^^^^^^^^^^^^^^^^^
+
+Note that these can be configured directly through the endpoint.
+
+
+// component options: START
+The GitHub component has no options.
+// component options: END
+
+
+// endpoint options: START
+The GitHub component supports 14 endpoint options which are listed below:
+
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| type | common |  | GitHubType | *Required* What git operation to execute
+| branchName | consumer |  | String | Name of branch
+| oauthToken | common |  | String | GitHub OAuth token required unless username & password
are provided
+| password | common |  | String | GitHub password required unless oauthToken is provided
+| repoName | common |  | String | *Required* GitHub repository name
+| repoOwner | common |  | String | *Required* GitHub repository owner (organization)
+| username | common |  | String | GitHub username required unless oauthToken is provided
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the
Camel routing Error Handler which mean any exceptions occurred while the consumer is trying
to pickup incoming messages or the likes will now be processed as a message and handled by
the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler
to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use
a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options
is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR
level and ignored.
+| encoding | producer |  | String | To use the given encoding when getting a git commit file
+| state | producer |  | String | To set git commit status state
+| targetUrl | producer |  | String | To set git commit status target url
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+// endpoint options: END
+
+
+[[GitHub-ConsumerEndpoints:]]
+Consumer Endpoints:
+^^^^^^^^^^^^^^^^^^^
+
+[width="100%",cols="20%,20%,60%",options="header",]
+|=======================================================================
+|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
+|=======================================================================
+
+[[GitHub-ProducerEndpoints:]]
+Producer Endpoints:
+^^^^^^^^^^^^^^^^^^^
+
+[width="100%",cols="20%,20%,60%",options="header",]
+|=======================================================================
+|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.
+|=======================================================================

http://git-wip-us.apache.org/repos/asf/camel/blob/61e192d0/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index a81fcfa..b80f02b 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -135,6 +135,7 @@
     * [Ganglia](ganglia.adoc)
     * [Geocoder](geocoder.adoc)
     * [Git](git.adoc)
+    * [Github](github.adoc)
     * [Ironmq](ironmq.adoc)
     * [JMS](jms.adoc)
     * [JMX](jmx.adoc)


Mime
View raw message