org.eclipse.tycho.extras.buildtimestamp.jgit

Class JGitBuildTimestampProvider

java.lang.Object

org.eclipse.tycho.extras.buildtimestamp.jgit.JGitBuildTimestampProvider

All Implemented Interfaces:

org.eclipse.tycho.buildversion.BuildTimestampProvider

@Component(role=org.eclipse.tycho.buildversion.BuildTimestampProvider.class,
           hint="jgit")
public class JGitBuildTimestampProvider
extends java.lang.Object
implements org.eclipse.tycho.buildversion.BuildTimestampProvider

Build timestamp provider that returns date of the most recent git commit that touches any file under project basedir. Because this timestamp provider is meant to be used for reproducible builds, by default an exception is thrown if git status is not clean (i.e. uncommitted changes are detected).

If uncommitted changes should be tolerated with a warning, configure

 <jgit.dirtyWorkingTree>warning</jgit.dirtyWorkingTree>
 

In this case, this timestamp provider will delegate to the default timestamp provider which uses the current build timestamp.

For additional flexibility, some files can be ignored using gitignore patters specified in <jgit.ignore> element of tycho-packaging-plugin configuration block.

Typical usage

 ...
       <plugin>
         <groupId>org.eclipse.tycho</groupId>
         <artifactId>tycho-packaging-plugin</artifactId>
         <version>${tycho-version}</version>
         <dependencies>
           <dependency>
             <groupId>org.eclipse.tycho.extras</groupId>
             <artifactId>tycho-buildtimestamp-jgit</artifactId>
             <version>${tycho-version}</version>
           </dependency>
         </dependencies>
         <configuration>
           <timestampProvider>jgit</timestampProvider>
           <jgit.ignore>pom.xml</jgit.ignore>
         </configuration>
       </plugin>
 ...
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JGitBuildTimestampProvider.DirtyBehavior

Field Summary

Fields

Modifier and Type	Field and Description
private org.eclipse.tycho.buildversion.BuildTimestampProvider	defaultTimestampProvider
private org.codehaus.plexus.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
JGitBuildTimestampProvider()

Method Summary

Modifier and Type	Method and Description
private static org.eclipse.jgit.treewalk.filter.TreeFilter	createPathFilter(java.lang.String relPath, org.apache.maven.plugin.MojoExecution execution)
private static java.lang.String	getIgnoreFilter(org.apache.maven.plugin.MojoExecution execution)
private java.lang.String	getRelPath(org.eclipse.jgit.lib.Repository repository, org.apache.maven.project.MavenProject project)
java.util.Date	getTimestamp(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project, org.apache.maven.plugin.MojoExecution execution)
private static void	printList(java.io.PrintWriter witer, java.lang.String prefix, java.util.Set<java.lang.String> files)
private static java.lang.String	toGitStatusStyleOutput(org.eclipse.jgit.lib.IndexDiff diff)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultTimestampProvider

@Requirement(hint="default")
private org.eclipse.tycho.buildversion.BuildTimestampProvider defaultTimestampProvider

logger

@Requirement
private org.codehaus.plexus.logging.Logger logger

Constructor Detail

JGitBuildTimestampProvider

public JGitBuildTimestampProvider()

Method Detail

getTimestamp

public java.util.Date getTimestamp(org.apache.maven.execution.MavenSession session,
                                   org.apache.maven.project.MavenProject project,
                                   org.apache.maven.plugin.MojoExecution execution)
                            throws org.apache.maven.plugin.MojoExecutionException

Specified by:

getTimestamp in interface org.eclipse.tycho.buildversion.BuildTimestampProvider

Throws:

org.apache.maven.plugin.MojoExecutionException

createPathFilter

private static org.eclipse.jgit.treewalk.filter.TreeFilter createPathFilter(java.lang.String relPath,
                                                                            org.apache.maven.plugin.MojoExecution execution)
                                                                     throws java.io.IOException

Throws:

java.io.IOException

getIgnoreFilter

private static java.lang.String getIgnoreFilter(org.apache.maven.plugin.MojoExecution execution)

getRelPath

private java.lang.String getRelPath(org.eclipse.jgit.lib.Repository repository,
                                    org.apache.maven.project.MavenProject project)
                             throws java.io.IOException

Throws:

java.io.IOException

toGitStatusStyleOutput

private static java.lang.String toGitStatusStyleOutput(org.eclipse.jgit.lib.IndexDiff diff)

printList

private static void printList(java.io.PrintWriter witer,
                              java.lang.String prefix,
                              java.util.Set<java.lang.String> files)