This page contains examples of provider match and function scripts for some common providers.
...
This sample Bitbucket function script manages FlexDeploy builds and project streams with the assumption it will be triggered from a Bitbucket push event.
| Info |
|---|
Bitbucket does not send changed files in the push event, but that information is available via the diffstat API. The getChangeLogs function will use that API and as such requires a valid user/password to make the api call. It is recommended that BITBUCKET_USER and BITBUCKET_PASSWORD provider properties are created for passing to this function. |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
//Execute FLEXDEPLOY functions on an incoming webhook message
def functionName = "BitbucketBuild";
LOG.info("Running function: ${functionName}");
//Find and build projects from the payload
//If the QUERY_PARAMS include a projectId that single project will be built instead
//The 3rd argument indicates to create any missing streams on the projects
//The last two arguments are for additional Bitbucket API calls to get change log information
BITBUCKET.buildProjects(PAYLOAD, null, true, BITBUCKET_USER ,BITBUCKET_PASSWORD); |
...
This function finds projects affected by a push from Azure Repos, gets the change logs, and builds relevant projects. The Azure push event includes branch created/deleted events, but Azure allows filtering webhooks to send by branch. In this case, webhooks will be received from Azure only for push events from main branches.
| Info |
|---|
Azure Repos does not send changed files in the push event, but that information is available via their commits API. The getChangeLogs function will use that API and as such requires a valid user/personal access token to make the API call. It is recommended that provider properties are created for passing to this function. |
| Info | ||
|---|---|---|
| ||
the AZURE object also includes a simplified buildProjects method like the other providers above which can be used in replacement of the below sample. |
...
| Code Block | ||
|---|---|---|
| ||
// perform checks and functions to ensure an incoming message is valid and matches this provider
LOG.fine("Evaluating Slack for incoming message");
def match = false;
def slackSecret = 'REPLACE_ME';
// validating based on slack secret
def slackSig = HTTP_HEADERS.get('x-slack-signature');
if (slackSig)
{
LOG.fine("Validating Slack provider with signature ${slackSig}");
def version = slackSig.split('=')[0];
def slackTimestamp = HTTP_HEADERS.get('x-slack-request-timestamp');
def hmacInput = version.concat(':').concat(slackTimestamp).concat(':').concat(FLX_PRISTINE_PAYLOAD);
//be sure to replace with your slack secret
//It's recommended to store the token as an encrypted provider property but it is not done here for completeness sake
def hmac = HMAC.generateHmacSHA256(hmacInput, slackSecret);
match = slackSig.contains(hmac);
}
LOG.fine("Slack provider is a match: ${match}");
return match; |
Microsoft Teams
...
See the Teams plugin configuration pages for information on how to set up FlexDeploy and Microsoft Teams.
...
This page only shows how to setup the Webhooks, not how to setup the integration itself.
Provider Match Script - Expected Teams headers (Incoming Webhook) - Available in 5.5.
...
0.2
This provider match script for Microsoft Teams validates that it is a message from a card that FlexDeploy created.
...
| Code Block | ||
|---|---|---|
| ||
return HTTP_HEADERS.containsKey("flex-sync-webhook") && "TeamsTask".equals(HTTP_HEADERS.get("flex-sync-webhook")); |
Function Script - Update Tasks from Teams Messages (Incoming Webhook) - Available in 5.5.
...
0.2
Microsoft Teams Incoming Webhooks are validated and processed Synchronously. Behind the scenes, the JWT token is validated and the message is checked for unauthorized modification. Then the task is approved or rejected, and the card is updated to indicate that the task was processed. The user that clicked the button is validated behind the scene using the JWT Token found in the HTTP Headers.
...