com.diffplug.spotless.changelog

Class GitActions

java.lang.Object

com.diffplug.spotless.changelog.GitActions

All Implemented Interfaces:

AutoCloseable

public class GitActions
extends Object
implements AutoCloseable

API for doing the commit, tag, and push operations. See GitCfg.withChangelog(File, ChangelogAndNext).

Method Summary

Modifier and Type	Method and Description
void	addAndCommit() Adds and commits the changelog.
void	assertNoTag() Asserts that there is no tag with the expected name.
void	checkCanPush() Confirms that we can update the target branch on the target remote.
void	close()
void	tagBranchPush() Tags and pushes the tag and the branch.

Methods inherited from class java.lang.Object

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

Method Detail

checkCanPush

public void checkCanPush()
                  throws org.eclipse.jgit.api.errors.GitAPIException,
                         IOException

Confirms that we can update the target branch on the target remote.

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

assertNoTag

public void assertNoTag()
                 throws IOException

Asserts that there is no tag with the expected name.

Throws:

IOException

addAndCommit

public void addAndCommit()
                  throws org.eclipse.jgit.api.errors.GitAPIException

Adds and commits the changelog.

Throws:

org.eclipse.jgit.api.errors.GitAPIException

tagBranchPush

public void tagBranchPush()
                   throws org.eclipse.jgit.api.errors.GitAPIException

Tags and pushes the tag and the branch.

Throws:

org.eclipse.jgit.api.errors.GitAPIException

close

public void close()

Specified by:

close in interface AutoCloseable