flexagon.fd.services.groovy.functions

Class GithubFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.GitProviderFunctions

flexagon.fd.services.groovy.functions.GithubFunctions

public class GithubFunctions
extends GitProviderFunctions

Utility functions used to get information from a GitHub payload

Since:

5.3

Field Summary

Fields inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
GithubFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
void	buildPackages(java.lang.Object pPayload, java.util.Map<java.lang.String,java.lang.String> pQueryParameters, java.lang.Boolean pCreateStreams) Build Packages using the given projectId and/or packageName in the query parameters or finding packages to build from the payload.
void	buildProjects(java.lang.Object pPayload, java.util.Map<java.lang.String,java.lang.String> pQueryParameters, java.lang.Boolean pCreateStreams) Build Projects using the given projectId in the query parameters or finding projects to build from the payload.
PollingResult	getChangeLogs(java.lang.Object pPayload) Finds FlexDeploy change logs from a GitHub payload.
PollingResult	getChangeLogs(java.lang.Object pPayload, boolean pIgnoreTargetBranchMerge) Finds FlexDeploy change logs from a GitHub payload.
java.lang.String	getGroovyKey()

Methods inherited from class flexagon.fd.services.groovy.functions.GitProviderFunctions

buildPackages, buildProjects, cleanup, getFlexDeployFunctions, getJsonObjectFromPayload, getOrCreateBranchId

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

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

Constructor Detail

GithubFunctions

public GithubFunctions(boolean isExecute,
                       LogFunctions pFLOG)

Method Detail

getChangeLogs

public PollingResult getChangeLogs(java.lang.Object pPayload)
                            throws FlexCheckedException

Finds FlexDeploy change logs from a GitHub payload. Return object can be passed to other FlexDeploy functions to improve performance.

Parameters:

pPayload - Json payload from GitHub push event. This MUST be the push event payload

Returns:

A PollingResult object containing information such as change logs, revisions and committer

Throws:

FlexCheckedException

getChangeLogs

public PollingResult getChangeLogs(java.lang.Object pPayload,
                                   boolean pIgnoreTargetBranchMerge)
                            throws FlexCheckedException

Finds FlexDeploy change logs from a GitHub payload. Return object can be passed to other FlexDeploy functions to improve performance.

Parameters:

pPayload - Json payload from GitHub push event. This MUST be the push event payload

pIgnoreTargetBranchMerge - Exclude commits that were merged from the target branch into this branch. When using git flow this will ignore merges done from the target branch 'develop' into your feature branch. Default value is true

Returns:

A PollingResult object containing information such as change logs, revisions and committer

Throws:

FlexCheckedException

buildPackages

public void buildPackages(java.lang.Object pPayload,
                          java.util.Map<java.lang.String,java.lang.String> pQueryParameters,
                          java.lang.Boolean pCreateStreams)
                   throws FlexCheckedException

Build Packages using the given projectId and/or packageName in the query parameters or finding packages to build from the payload.

Parameters:

pPayload - Json payload from GitHub push event. This MUST be the push event payload

pQueryParameters - Query Parameters from GitHub push event. This must be the push event payload.

pCreateStreams - Should streams be created if not found on the projects?

Throws:

FlexCheckedException

buildProjects

public void buildProjects(java.lang.Object pPayload,
                          java.util.Map<java.lang.String,java.lang.String> pQueryParameters,
                          java.lang.Boolean pCreateStreams)
                   throws FlexCheckedException

Build Projects using the given projectId in the query parameters or finding projects to build from the payload.

Parameters:

pPayload - Json payload from GitHub push event. This MUST be the push event payload

pQueryParameters - Query Parameters from GitHub push event. This must be the push event payload.

pCreateStreams - Should streams be created if not found on the projects?

Throws:

FlexCheckedException

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in class BaseFunctions