net.nemerosa.ontrack.extension.git.service

Interface GitService

All Superinterfaces:

net.nemerosa.ontrack.extension.scm.service.SCMService

All Known Implementing Classes:

GitServiceImpl

public interface GitService
extends net.nemerosa.ontrack.extension.scm.service.SCMService

Method Summary

Modifier and Type	Method and Description
GitChangeLog	changeLog(net.nemerosa.ontrack.extension.api.model.BuildDiffRequest request) Change log
java.lang.String	diff(GitChangeLog changeLog, java.util.List<java.lang.String> patterns) Gets a diff on a list of file changes, filtering the changes using ANT-like patterns
void	forEachConfiguredBranch(java.util.function.BiConsumer<net.nemerosa.ontrack.model.structure.Branch,GitBranchConfiguration> consumer) Loops over each correctly configured branch.
void	forEachConfiguredProject(java.util.function.BiConsumer<net.nemerosa.ontrack.model.structure.Project,GitConfiguration> consumer) Loops over each correctly configured project.
java.util.Optional<GitBranchConfiguration>	getBranchConfiguration(net.nemerosa.ontrack.model.structure.Branch branch) Gets the configuration for a branch
GitChangeLogCommits	getChangeLogCommits(GitChangeLog changeLog) Change log commits
GitChangeLogFiles	getChangeLogFiles(GitChangeLog changeLog) Change log files
GitChangeLogIssues	getChangeLogIssues(GitChangeLog changeLog) Change log issues
OntrackGitCommitInfo	getCommitInfo(net.nemerosa.ontrack.model.structure.ID branchId, java.lang.String commit) Gets information about a commit in a Git-configured branch.
OntrackGitIssueInfo	getIssueInfo(net.nemerosa.ontrack.model.structure.ID branchId, java.lang.String key) Gets information about an issue in a Git-configured branch
java.util.Optional<GitConfiguration>	getProjectConfiguration(net.nemerosa.ontrack.model.structure.Project project) Gets the configuration for a project.
GitSynchronisationInfo	getProjectGitSyncInfo(net.nemerosa.ontrack.model.structure.Project project) Gets the Git synchronisation information.
java.util.List<java.lang.String>	getRemoteBranches(GitConfiguration gitConfiguration) Gets the list of remote branches, as defined under ref/heads.
boolean	isBranchConfiguredForGit(net.nemerosa.ontrack.model.structure.Branch branch) Tests if a branch is correctly configured for Git.
java.util.Optional<java.util.concurrent.Future<?>>	launchBuildSync(net.nemerosa.ontrack.model.structure.ID branchId, boolean synchronous) Launches the build/tag synchronisation for a branch
java.util.Optional<GitUICommit>	lookupCommit(GitConfiguration configuration, java.lang.String id) Looks up a commit in the given configuration.
net.nemerosa.ontrack.model.Ack	projectSync(net.nemerosa.ontrack.model.structure.Project project, GitSynchronisationRequest request) Synchronises the Git repository attached to this project.
boolean	scanCommits(GitBranchConfiguration branchConfiguration, java.util.function.Predicate<org.eclipse.jgit.revwalk.RevCommit> scanFunction) Scans the whole history of a repository.
void	scheduleGitBuildSync(net.nemerosa.ontrack.model.structure.Branch branch, GitBranchConfigurationProperty property)
java.util.Optional<java.util.concurrent.Future<?>>	sync(GitConfiguration gitConfiguration, GitSynchronisationRequest request) Synchronises the Git repository attached to this configuration.
void	unscheduleGitBuildSync(net.nemerosa.ontrack.model.structure.Branch branch, GitBranchConfigurationProperty property)

Methods inherited from interface net.nemerosa.ontrack.extension.scm.service.SCMService

download, getSCMPathInfo

Method Detail

isBranchConfiguredForGit

boolean isBranchConfiguredForGit(net.nemerosa.ontrack.model.structure.Branch branch)

Tests if a branch is correctly configured for Git.

getProjectConfiguration

java.util.Optional<GitConfiguration> getProjectConfiguration(net.nemerosa.ontrack.model.structure.Project project)

Gets the configuration for a project.

getBranchConfiguration

java.util.Optional<GitBranchConfiguration> getBranchConfiguration(net.nemerosa.ontrack.model.structure.Branch branch)

Gets the configuration for a branch

Parameters:

branch - Branch to check

Returns:

Configuration.

launchBuildSync

java.util.Optional<java.util.concurrent.Future<?>> launchBuildSync(net.nemerosa.ontrack.model.structure.ID branchId,
                                                                   boolean synchronous)

Launches the build/tag synchronisation for a branch

changeLog

GitChangeLog changeLog(net.nemerosa.ontrack.extension.api.model.BuildDiffRequest request)

Change log

getChangeLogCommits

GitChangeLogCommits getChangeLogCommits(GitChangeLog changeLog)

Change log commits

getChangeLogIssues

GitChangeLogIssues getChangeLogIssues(GitChangeLog changeLog)

Change log issues

getChangeLogFiles

GitChangeLogFiles getChangeLogFiles(GitChangeLog changeLog)

Change log files

forEachConfiguredProject

void forEachConfiguredProject(java.util.function.BiConsumer<net.nemerosa.ontrack.model.structure.Project,GitConfiguration> consumer)

Loops over each correctly configured project.

forEachConfiguredBranch

void forEachConfiguredBranch(java.util.function.BiConsumer<net.nemerosa.ontrack.model.structure.Branch,GitBranchConfiguration> consumer)

Loops over each correctly configured branch. Branch template definitions are excluded.

scanCommits

boolean scanCommits(GitBranchConfiguration branchConfiguration,
                    java.util.function.Predicate<org.eclipse.jgit.revwalk.RevCommit> scanFunction)

Scans the whole history of a repository.

Parameters:

branchConfiguration - Repository branch to scan

scanFunction - Function that scans the commits. Returns true if the scan must not go on, false otherwise.

Returns:

true if at least one call to scanFunction has returned true.

getIssueInfo

OntrackGitIssueInfo getIssueInfo(net.nemerosa.ontrack.model.structure.ID branchId,
                                 java.lang.String key)

Gets information about an issue in a Git-configured branch

lookupCommit

java.util.Optional<GitUICommit> lookupCommit(GitConfiguration configuration,
                                             java.lang.String id)

Looks up a commit in the given configuration.

Parameters:

id - Commit long or short ID

Returns:

The content of a commit if it exists, empty otherwise.

getCommitInfo

OntrackGitCommitInfo getCommitInfo(net.nemerosa.ontrack.model.structure.ID branchId,
                                   java.lang.String commit)

Gets information about a commit in a Git-configured branch.

getRemoteBranches

java.util.List<java.lang.String> getRemoteBranches(GitConfiguration gitConfiguration)

Gets the list of remote branches, as defined under ref/heads.

diff

java.lang.String diff(GitChangeLog changeLog,
                      java.util.List<java.lang.String> patterns)

Gets a diff on a list of file changes, filtering the changes using ANT-like patterns

projectSync

net.nemerosa.ontrack.model.Ack projectSync(net.nemerosa.ontrack.model.structure.Project project,
                                           GitSynchronisationRequest request)

Synchronises the Git repository attached to this project.

Parameters:

project - Project

request - Sync request

Returns:

Result. The synchronisation will occur asynchronously, but the acknowledgment returns if the project did contain a Git configuration or not.

sync

java.util.Optional<java.util.concurrent.Future<?>> sync(GitConfiguration gitConfiguration,
                                                        GitSynchronisationRequest request)

Synchronises the Git repository attached to this configuration.

Parameters:

gitConfiguration - Configuration to sync

request - Sync request

Returns:

Result. The synchronisation will occur asynchronously, but the acknowledgment returns if the synchronisation was actually launched.

getProjectGitSyncInfo

GitSynchronisationInfo getProjectGitSyncInfo(net.nemerosa.ontrack.model.structure.Project project)

Gets the Git synchronisation information.

Parameters:

project - Project configured for Git

Returns:

Synchronisation information

scheduleGitBuildSync

void scheduleGitBuildSync(net.nemerosa.ontrack.model.structure.Branch branch,
                          GitBranchConfigurationProperty property)

unscheduleGitBuildSync

void unscheduleGitBuildSync(net.nemerosa.ontrack.model.structure.Branch branch,
                            GitBranchConfigurationProperty property)