git-checkout-plugin

A Maven plugin to perform a sparse checkout (fetch only a subtree) from a given Git repository.

For details on sparse checkout see https://git-scm.com/docs/git-read-tree.

Forked from the original https://github.com/gastaldi/git-checkout-plugin

POM Configuration

<project>
  ...
  <build>
    <plugins>
       <plugin>
          <groupId>com.github.lzaruba</groupId>
          <artifactId>git-checkout-plugin</artifactId>
          <version>1.0.1</version>
          <executions>
             <execution>
                <id>get-docs</id>
                <phase>process-resources</phase>
                <goals>
                   <goal>git-checkout</goal>
                </goals>
             </execution>
          </executions>
          <configuration>
             <!-- The git repository to use -->
             <repository>https://github.com/LZaruba/git-checkout-plugin</repository>
             <!-- The paths to checkout -->
             <paths>
                <path>example</path>
             </paths>
          </configuration>
       </plugin>
    </plugins>
  </build>
   ...
</project>

Output

[INFO] --- git-checkout-plugin:1.0.0-SNAPSHOT:git-checkout (get-docs) @ launchpad-addon ---
Initialized empty Git repository in /home/ggastald/workspace/launchpad/launchpad-addon/target/classes/.git/
remote: Counting objects: 2614, done.
remote: Compressing objects: 100% (5/5), done.
remote: Total 2614 (delta 0), reused 1 (delta 0), pack-reused 2609
Receiving objects: 100% (2614/2614), 2.90 MiB | 1.00 MiB/s, done.
Resolving deltas: 100% (1570/1570), done.
From github.com:openshiftio/appdev-documentation
 * branch            master     -> FETCH_HEAD
 * [new branch]      master     -> origin/master
[INFO] Files available in: /home/ggastald/workspace/launchpad/launchpad-addon/target/classes

Parameters

Name	Default Value	Required	Description
`repository`		true	URL of the repository (both ssh and https work)
`paths`		true	List of paths to be picked up from the repository (will be added to $GIT_DIR/info/sparse-checkout).
`outputDirectory`	${project.build.outputDirectory}	false	Directory into which the git content will be checked out
`branch`	master	false	Specifies branch to be checked out
`username`		false	If provided and `repository` schema is https it will be added to the url
`pasword`		false	If provided it will be added to the `username` in url. Cannot be provided without `username`