Commit hook usage

[djarnis73]

Hi

I was wondering if anyone has a tip for using the gitflow-incremental-builder in a git pre commit hook?

My current pre-commit hook looks something like:

#!/bin/bash
# pre-commit hook that compiles the git index (which is what is about to be committed)
set -x
# create temporary directory to copy git index into
TMPDIR=$(mktemp -d)

# setup cleanup so we delete the temp dir when we are done
function _cleanup {
  rm -rf $TMPDIR
}
trap _cleanup EXIT

# copy the git index (what we are about to commit) into the tmpdir
git checkout-index -a --prefix=${TMPDIR}/

./mvnw test -f ${TMPDIR}/ -q

So when running maven there is no .git folder. But perhaps there is a trick I could use?

[famod]

Hi!

It's not quite clear to me what you are trying to achieve?
Do you want GIB to consider only the changed that were added to the index?

[djarnis73]

Perhaps I can just copy the .git folder into the tmpdir? But the .git folder is quite large (250MB) vs the the project itself (75MB) but SSD's are fast, so perhaps not a problem.

[famod]

Instead of copying anything, have you tried ./mvnw test -Dgib.disableBranchComparison -Dgib.uncommitted?

[djarnis73]

Well, I often do partial commits (as in not add every change before committing), the above hook checks out the git index in a temporary location so the maven build runs only on what is about to be committed.

If I just run maven in the current directory, it may succeed but break the build.

[famod]

Have you found a solution for this?

I think I have finally understood (I hope) what your main issue is: your hook is running GIB (via mvn) on the checked out index but as checkout-index is not copying .git(?), GIB fails. Is that correct?
What if you simply copy .gitas well? Well, you already said that yourself. 😅 Alternatively, you could just create a link (soft or hard).

[djarnis73]

Hi, sorry for the late reply.

I just tested it out with a symbolic link, and it looks like a working solution. Here is a revised git pre-commit file:

#!/bin/bash
# pre-commit hook that runs maven build the git index (which is what is about to be committed)
set -x

# create temporary directory to copy git index into
TMPDIR=$(mktemp -d)

# setup cleanup so we delete the temp dir when we are done
function _cleanup {
	rm -rf $TMPDIR
}
trap _cleanup EXIT

# copy the git index (what we are about to commit) into the tmpdir
git checkout-index -a --prefix=${TMPDIR}/

# create symbolic from in the tmpdir .git so the gitflow-incremental-builder can work
ln -s ${PWD}/.git ${TMPDIR}/.git

# run build (-am is needed to for gitflow-incremental-builder to build upstream modules)
./mvnw test -f ${TMPDIR}/ -Pgib -am

I added gitflow-incremental-builder in a maven profile called gib like:

<profile>
  <id>gib</id>
  <build>
    <plugins>
      <plugin>
        <groupId>io.github.gitflow-incremental-builder</groupId>
        <artifactId>gitflow-incremental-builder</artifactId>
        <version>4.3.0</version>
        <extensions>true</extensions>
        <configuration>
          <!-- when using in a commit hook, we have not yet committed anything yet, so include uncommitted and untracked files in change detection -->
          <uncommitted>true</uncommitted>
          <untracked>true</untracked>
        </configuration>
      </plugin>
    </plugins>
  </build>
</profile>

It looks promising but I still need to do some more testing.