org.paylogic.jenkins.advancedscm

Interface AdvancedSCMManager

All Known Implementing Classes:

GitBackend, MercurialBackend

public interface AdvancedSCMManager

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Cleans workspace from artifacts.
void	closeBranch(String branch, String message, String username) Close given branch
void	commit(String message, String username) Commit current workspace.
ReleaseBranch	createReleaseBranch(String branch, String releaseFilePath, String releaseFileContent, String message, String username) Create the release branch.
void	ensureReleaseBranch(String branch, String releaseFilePath, String releaseFileContent, String message, String username) Ensure the release branch exists.
String	getBranch() Get the current branch name in the workspace.
List<Branch>	getBranches(boolean all) Get Mercurial branches from command line output, and put them in a List with Branches so it's nice to work with.
List<String>	getBranchNames(boolean all) Get open Mercurial branches from command line output, and put them in a List so it's nice to work with.
ReleaseBranch	getReleaseBranch(String branch) Get release branch from given branch name.
void	mergeHeads(String message, String username) Merge possible current branch's heads.
void	mergeWorkspaceWith(String revision, String updateTo) Merge current workspace with given revision.
void	pull() Executes 'pull' command
void	pull(String remote) Pulls changes from remotes.
void	pull(String remote, String branch) Pulls from given repository url.
void	push(String... branchNames) Executes 'push' command with -b
void	stripLocal() Strip out local commits which are not pushed yet.
void	update(String revision) Updates workspace to given revision/branch.
void	updateClean(String revision) Updates workspace to given revision/branch with cleaning.

Method Detail

getBranches

List<Branch> getBranches(boolean all)
                         throws AdvancedSCMException

Get Mercurial branches from command line output, and put them in a List with Branches so it's nice to work with.

Parameters:

all - : get all or only open branches

Returns:

List of Branches

Throws:

AdvancedSCMException

getBranchNames

List<String> getBranchNames(boolean all)
                            throws AdvancedSCMException

Get open Mercurial branches from command line output, and put them in a List so it's nice to work with.

Parameters:

all - : get all or only open branches

Returns:

List of String

Throws:

AdvancedSCMException

getBranch

String getBranch()
                 throws AdvancedSCMException

Get the current branch name in the workspace.

Returns:

String with branch name in it.

Throws:

AdvancedSCMException

update

void update(String revision)
            throws AdvancedSCMException

Updates workspace to given revision/branch.

Parameters:

revision - : String with revision, hash of branchname to update to.

Throws:

AdvancedSCMException

updateClean

void updateClean(String revision)
                 throws AdvancedSCMException

Updates workspace to given revision/branch with cleaning.

Parameters:

revision - : String with revision, hash of branchname to update to.

Throws:

AdvancedSCMException

stripLocal

void stripLocal()
                throws AdvancedSCMException

Strip out local commits which are not pushed yet.

Throws:

AdvancedSCMException

clean

void clean()
           throws AdvancedSCMException

Cleans workspace from artifacts.

Throws:

AdvancedSCMException

mergeWorkspaceWith

void mergeWorkspaceWith(String revision,
                      String updateTo)
                        throws AdvancedSCMException

Merge current workspace with given revision.

Parameters:

revision - : String with revision, hash or branchname to merge with.

updateTo - : String with revision, hash or branchname to update working copy to before actual merge.

Throws:

AdvancedSCMException

commit

void commit(String message,
          String username)
            throws AdvancedSCMException

Commit current workspace.

Parameters:

message - : String commit message

username - : String commit user name (with email)

Throws:

AdvancedSCMException

mergeHeads

void mergeHeads(String message,
              String username)
                throws AdvancedSCMException

Merge possible current branch's heads.

Parameters:

message - : String commit message

username - : String commit user name (with email)

Throws:

AdvancedSCMException

closeBranch

void closeBranch(String branch,
               String message,
               String username)
                 throws AdvancedSCMException

Close given branch

Parameters:

branch: - String branch name.

message - : String with message to give this commit.

username - : String commit user name (with email)

Throws:

AdvancedSCMException

push

void push(String... branchNames)
          throws AdvancedSCMException

Executes 'push' command with -b

Throws:

AdvancedSCMException

pull

void pull()
          throws AdvancedSCMException

Executes 'pull' command

Throws:

AdvancedSCMException

pull

void pull(String remote)
          throws AdvancedSCMException

Pulls changes from remotes. Give it a remote to pull changes from there.

Throws:

AdvancedSCMException

pull

void pull(String remote,
        String branch)
          throws AdvancedSCMException

Pulls from given repository url. Give it a remote to pull changes from there.

Throws:

AdvancedSCMException

getReleaseBranch

ReleaseBranch getReleaseBranch(String branch)
                               throws ReleaseBranchInvalidException

Get release branch from given branch name.

Parameters:

branch - : String branch name

Returns:

ReleaseBranch : release branch object

Throws:

ReleaseBranchInvalidException

ensureReleaseBranch

void ensureReleaseBranch(String branch,
                       String releaseFilePath,
                       String releaseFileContent,
                       String message,
                       String username)
                         throws AdvancedSCMException,
                                ReleaseBranchInvalidException

Ensure the release branch exists.

Parameters:

branch - : String branch name

releaseFilePath: - String relative path of the release file

releaseFileContent - : String release file content

message: - String commit message to add release file

username: - String username of the commit commit

Throws:

AdvancedSCMException

ReleaseBranchInvalidException

createReleaseBranch

ReleaseBranch createReleaseBranch(String branch,
                                String releaseFilePath,
                                String releaseFileContent,
                                String message,
                                String username)
                                  throws AdvancedSCMException,
                                         ReleaseBranchInvalidException

Create the release branch.

Parameters:

branch - : String branch name

releaseFilePath: - String relative path of the release file

releaseFileContent - : String release file content

message: - String commit message to add release file

username: - String username of the commit commit

Throws:

AdvancedSCMException

ReleaseBranchInvalidException