Merge pull request #104 from ajoberstar/shallow

Support shallow clones/fetches

Author: ajoberstar

README.md

@@ -50,6 +50,9 @@ gitPublish {
 
     // branch will be created if it doesn't exist
     branch = 'gh-pages'
+  
+    // if set, a shallow clone will be performed instead of pulling all history
+    fetchDepth = null
 
     // generally, you don't need to touch this
     repoDir = file("$buildDir/somewhereelse") // defaults to $buildDir/gitPublish

gradle.lockfile

@@ -4,12 +4,12 @@
 cglib:cglib-nodep:3.3.0=compatTestCompileClasspath,compatTestRuntimeClasspath
 com.googlecode.javaewah:JavaEWAH:1.1.13=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 net.bytebuddy:byte-buddy:1.11.0=compatTestCompileClasspath,compatTestRuntimeClasspath
-org.ajoberstar.grgit:grgit-core:5.0.0=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-org.ajoberstar.grgit:grgit-gradle:5.0.0=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.ajoberstar.grgit:grgit-core:5.2.0=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.ajoberstar.grgit:grgit-gradle:5.2.0=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.apiguardian:apiguardian-api:1.1.0=compatTestCompileClasspath,compatTestRuntimeClasspath
 org.assertj:assertj-core:3.16.1=compatTestCompileClasspath,compatTestRuntimeClasspath
-org.codehaus.groovy:groovy:3.0.9=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-org.eclipse.jgit:org.eclipse.jgit:6.0.0.202111291000-r=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.codehaus.groovy:groovy:3.0.17=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+org.eclipse.jgit:org.eclipse.jgit:6.5.0.202303070854-r=compatTestCompileClasspath,compatTestRuntimeClasspath,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.hamcrest:hamcrest:2.2=compatTestCompileClasspath,compatTestRuntimeClasspath
 org.jetbrains:annotations:20.1.0=compatTestCompileClasspath,compatTestRuntimeClasspath
 org.junit.platform:junit-platform-commons:1.7.2=compatTestCompileClasspath,compatTestRuntimeClasspath

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -92,6 +92,41 @@ gitPublish {
     remoteFile('content.txt').text == 'published content here'
   }
 
+  def 'publish with fetchDepth 1 adds to history if branch already exists'() {
+    given:
+    remote.checkout(branch: 'gh-pages')
+    remoteFile('index.md') << 'And has great content'
+    remote.add(patterns: ['.'])
+    remote.commit(message: 'second pages commit')
+    remote.checkout(branch: 'master')
+
+    projectFile('src/content.txt') << 'published content here'
+
+    buildFile << """
+plugins {
+  id 'org.ajoberstar.git-publish'
+}
+
+gitPublish {
+  repoUri = '${remote.repository.rootDir.toURI()}'
+  branch = 'gh-pages'
+  fetchDepth = 1
+  contents.from 'src'
+}
+"""
+    when:
+    def result = build()
+    and:
+    remote.checkout(branch: 'gh-pages')
+    then:
+    result.task(':gitPublishPush').outcome == TaskOutcome.SUCCESS
+    remote.log().size() == 3
+    remoteFile('content.txt').text == 'published content here'
+    def working = Grgit.open(dir: "${projectDir}/build/gitPublish/main")
+    working.head().parentIds.collect { working.resolve.toCommit(it).parentIds == [] }
+    working.close()
+  }
+
   def 'reset pulls from reference repo if available before pulling from remote'() {
     given:
     def referenceDir = new File(tempDir, 'reference')
@@ -339,7 +374,6 @@ task hello {
     notThrown(UnexpectedBuildFailure)
   }
 
-  @IgnoreIf({ Integer.parseInt(System.properties['compat.gradle.version'].split('\\.')[0]) < 5 })
   def 'commit message can be changed'() {
      given:
     projectFile('src/content.txt') << 'published content here'

gradlew

@@ -16,6 +16,7 @@ public class GitPublication implements Named {
   private final Property<String> repoUri;
   private final Property<String> referenceRepoUri;
   private final Property<String> branch;
+  private final Property<Integer> fetchDepth;
   private final Property<String> commitMessage;
   private final Property<Boolean> sign;
   private final CopySpec contents;
@@ -27,6 +28,7 @@ public GitPublication(String name, Project project, ObjectFactory objectFactory)
     this.repoUri = objectFactory.property(String.class);
     this.referenceRepoUri = objectFactory.property(String.class);
     this.branch = objectFactory.property(String.class);
+    this.fetchDepth = objectFactory.property(Integer.class);
     this.commitMessage = objectFactory.property(String.class);
     this.sign = objectFactory.property(Boolean.class);
 
@@ -56,6 +58,10 @@ public Property<String> getBranch() {
     return branch;
   }
 
+  public Property<Integer> getFetchDepth() {
+    return fetchDepth;
+  }
+
   public Property<String> getCommitMessage() {
     return commitMessage;
   }

gradlew.bat

@@ -43,6 +43,10 @@ public Property<String> getBranch() {
     return publications.getByName("main").getBranch();
   }
 
+  public Property<Integer> getFetchDepth() {
+    return publications.getByName("main").getFetchDepth();
+  }
+
   public Property<String> getCommitMessage() {
     return publications.getByName("main").getCommitMessage();
   }

src/compatTest/groovy/org/ajoberstar/gradle/git/publish/BaseCompatTest.groovy

@@ -73,6 +73,7 @@ private TaskProvider<GitPublishReset> createResetTask(Project project, GitPublic
       task.getRepoUri().set(publication.getRepoUri());
       task.getReferenceRepoUri().set(publication.getReferenceRepoUri());
       task.getBranch().set(publication.getBranch());
+      task.getFetchDepth().set(publication.getFetchDepth());
       task.setPreserve(publication.getPreserve());
     });
   }