[[git-component]]
= Git Component
:page-source: components/camel-git/src/main/docs/git-component.adoc

*Available as of Camel version 2.16*


The *git:* component allows you to work with a generic Git repository. 

[source,xml]
------------------------------------------------------------
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-git</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
------------------------------------------------------------

*URI Format*

[source,java]
-----------------------------------
git://localRepositoryPath[?options]
-----------------------------------

== URI Options

The producer allows to do operations on a specific repository.

The consumer allows consuming commits, tags and branches on a specific
repository.


// component options: START
The Git component has no options.
// component options: END




// endpoint options: START
The Git endpoint is configured using URI syntax:

----
git:localPath
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *localPath* | *Required* Local repository path |  | String
|===


=== Query Parameters (13 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *branchName* (common) | The branch name to work on |  | String
| *password* (common) | Remote repository password |  | String
| *remoteName* (common) | The remote repository name to use in particular operation like pull |  | String
| *remotePath* (common) | The remote repository path |  | String
| *tagName* (common) | The tag name to work on |  | String
| *username* (common) | Remote repository username |  | String
| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean
| *type* (consumer) | The consumer type |  | GitType
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. |  | ExchangePattern
| *allowEmpty* (producer) | The flag to manage empty git commits | true | boolean
| *operation* (producer) | The operation to do on the repository |  | String
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|===
// endpoint options: END
// spring-boot-auto-configure options: START
== Spring Boot Auto-Configuration

When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-git-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
----


The component supports 2 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.component.git.enabled* | Enable git component | true | Boolean
| *camel.component.git.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
|===
// spring-boot-auto-configure options: END





== Message Headers

[width="100%",cols="10%,10%,10%,20%,50%",options="header",]
|=======================================================================
|Name |Default Value |Type |Context |Description

|CamelGitOperation |`null` |String |Producer |The operation to do on a repository, if not specified as endpoint option

|CamelGitFilename |`null` |String |Producer |The file name in an add operation

|CamelGitCommitMessage |`null` |String |Producer |The commit message related in a commit operation

|CamelGitCommitUsername |`null` |String |Producer |The commit username in a commit operation

|CamelGitCommitEmail |`null` |String |Producer |The commit email in a commit operation

|CamelGitCommitId |`null` |String |Producer |The commit id

|CamelGitAllowEmpty |`null` |Boolean |Producer |The flag to manage empty git commits

|=======================================================================

== Producer Example

Below is an example route of a producer that add a file test.java to a
local repository, commit it with a specific message on master branch and
then push it to remote repository.

[source,java]
--------------------------------------------------------------------------------------------------------------------
from("direct:start")
        .setHeader(GitConstants.GIT_FILE_NAME, constant("test.java"))
        .to("git:///tmp/testRepo?operation=add")
        .setHeader(GitConstants.GIT_COMMIT_MESSAGE, constant("first commit"))
        .to("git:///tmp/testRepo?operation=commit")
        .to("git:///tmp/testRepo?operation=push&remotePath=https://foo.com/test/test.git&username=xxx&password=xxx")
        .to("git:///tmp/testRepo?operation=createTag&tagName=myTag")
        .to("git:///tmp/testRepo?operation=pushTag&tagName=myTag&remoteName=origin")
--------------------------------------------------------------------------------------------------------------------

== Consumer Example

Below is an example route of a consumer that consumes commit:

[source,java]
---------------------------------------
from("git:///tmp/testRepo?type=commit")
                        .to(....)
---------------------------------------