Git Connector API Reference

Connector Summary

• Configs
  • Git Configuration
• Processors
  • Clone repository
  • Reset repository
  • Add
  • Create branch
  • Delete branch
  • Commit
  • Push
  • Pull
  • Fetch
  • Checkout

Additional Info

Requires Mule Enterprise License	No [remove]
Requires Entitlement	No [remove]
Mule Version	3.5.0 or higher

Configs

---

Git Configuration

<git:config>

Connection Management

Attributes

Name	Java Type	Description	Default Value	Required
name	String	The name of this configuration. With this name can be later referenced.		x
username	String	A username		x
password	String	A password		x
directory	String	Default repository base directory

Processors

---

Clone repository

<git:clone-repository>

Clone a repository into a new directory or resset it if it exists ../../../doc/mule-module-git.xml.sample git:clone

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
uri	String	The (possibly remote) repository to clone from.		x
bare	boolean	True if you want a bare Git repository, false otherwise.	false
remote	String	Name of the remote to keep track of the upstream repository.	origin
branch	String	Name of the local branch into which the remote will be cloned.	HEAD
overrideDirectory	String	Name of the directory to use for git repository

---

Reset repository

<git:reset-repository>

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
branch	String		HEAD
overrideDirectory	String

---

Add

<git:add>

Add file contents to the index ../../../doc/mule-module-git.xml.sample git:add

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
filePatterns	String	List of file patterns to add content from. Also a leading directory name (e.g. dir to add dir/file1 and dir/file2) can be given to add all files in the directory, recursively. Use semicolon (";") to separete patterns
forceAll	boolean	Add all files	false
overrideDirectory	String	Name of the directory to use for git repository

---

Create branch

<git:create-branch>

Create a local branch ../../../doc/mule-module-git.xml.sample git:create-branch

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
branchName	String	Name of the new branch		x
force	boolean	If true and the branch with the given name already exists, the start-point of an existing branch will be set to a new start-point; if false, the existing branch will not be changed.	false
startPoint	String	The new branch head will point to this commit. It may be given as a branch name, a commit-id, or a tag. If this option is omitted, the current HEAD will be used instead.	HEAD
overrideDirectory	String	Name of the directory to use for git repository

---

Delete branch

<git:delete-branch>

Delete local branch ../../../doc/mule-module-git.xml.sample git:delete-branch

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
branchName	String	Name of the branch to delete		x
force	boolean	If false a check will be performed whether the branch to be deleted is already merged into the current branch and deletion will be refused in this case		x
overrideDirectory	String	Name of the directory to use for git repository

---

Commit

<git:commit>

Record changes to the repository ../../../doc/mule-module-git.xml.sample git:commit

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
msg	String	Commit message		x
committerName	String	Name of the person performing this commit		x
committerEmail	String	Email of the person performing this commit		x
authorName	String	Name of the author of the changes to commit
authorEmail	String	Email of the author of the changes to commit
all	boolean	If set to true the Commit command automatically stages files that have been modified and deleted, but new files not known by the repository are not affected.	false
overrideDirectory	String	Name of the directory to use for git repository

---

Push

<git:push>

Update remote refs along with associated objects ../../../doc/mule-module-git.xml.sample git:push

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
remote	String	The remote (uri or name) used for the push operation.	origin
force	boolean	Sets the force preference for push operation	false
overrideDirectory	String	Name of the directory to use for git repository

---

Pull

<git:pull>

Fetch from and merge with another repository or a local branch ../../../doc/mule-module-git.xml.sample git:pull

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
overrideDirectory	String	Name of the directory to use for git repository

---

Fetch

<git:fetch>

Fetch changes from another repository ../../../doc/mule-module-git.xml.sample git:fetch

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
overrideDirectory	String	Name of the directory to use for git repository

---

Checkout

<git:checkout>

Checkout a local branch or create a local branch from a remote branch ../../../doc/mule-module-git.xml.sample git:checkout or ../../../doc/mule-module-git.xml.sample git:checkout

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
branch	String	Name of the branch to checkout		x
startPoint	String	If specified creates a new branch pointing to this startPoint
overrideDirectory	String	Name of the directory to use for git repository