Use this action to push any environment information (ex: deployment, status, configuration,...) to Golive when your workflows are changing your environments.
This is your “swiss knife” task to track your environments managed in Github.
Apwide Golive is the game-changing solution for comprehensive test environment management.
Seamlessly integrated with your development and release processes, Apwide Golive empowers your teams to deliver high-quality software with speed and confidence. Apwide Golive provides a centralized dashboard for visualizing and tracking environment usage, resource allocation, and availability right in Jira.
With integrated notifications and approvals in Jira, stakeholders stay informed and can provide quick feedback, reducing delays and accelerating the testing process.
Learn more about Apwide Golive: https://www.apwide.com
(*) required
Golive API Token (Golive Cloud). How to get a token?
Api Base Url (Golive Server)
Used only for Apwide Golive on Jira Server to specify the Rest API Base URL. (eg: https://jira.mycompany.com/rest/apwide/tem/1.1)
Not needed on Golive Cloud, the API endpoint is common any Jira Cloud instance and is the default value.
Default value: https://golive.apwide.net/api
Golive API Username (Golive Server)
Golive API Password (Golive Server)
Github token (${{secrets.GITHUB_TOKEN}})
Target environment the version is deployed to
Name of the environment in Apwide Golive
Create the target environment with provided information if it does not exist yet in Apwide Golive.
Type the name of the application to select or create the target environment.
Select an existing application to use to find/create the target environment.
Create the target application with provided name if it does not exist yet in Apwide Golive. N.B. User associated to your connection must have permission to manage applications in order to automatically create new applications.
Type the name of the category to find/create the target environment.
Select an existing category to use to find/create the target environment.
Create the target category with provided name if it does not exist yet in Apwide Golive. N.B. User associated to your connection must have permission to manage categories in order to automatically create new categories.
Deployed version name
Build number of the deployed version. Ex: $(Build.BuildNumber)
Date in ISO-8601 format. Ex: 2023-09-24T12:00:00Z
Description of the deployment (markdown is supported). Ex:
✅ **Job** #$(Build.BuildId) - $(Build.DefinitionName)
Requested by: $(Build.RequestedFor)
Branch: $(Build.SourceBranchName)Deployment attribute values in key-value JSON format. Ex:
{
"Requested By" : "[email protected]",
"Artefacts" : "https://binaries.company.com/download/232323",
"Repository" : "https://github.com/"
}Comma separated list of Jira issue keys that are deployed. Ex: ECOM-3412,ECOM-6783,PAY-98
Parse and retrieve the Jira issue keys found in commit history and add them to the current deployment.
This option requires you to have checked out your repository with fetch-depth: 0 of the actions/checkout@v4 action
Set the JQL query used to retrieve and add Jira tickets to the current deployment. Ex: project = ECP AND type in (Story, Bug) AND resolution in (Fixed). More about JQL here
Add all "Done" issues fixed in the deployed Jira version to the current deployment
Do not add the deployed Jira version to "Fix versions" of the deployed Jira issues.
Trigger the standard Jira notification when updating the "Fix versions" of the deployed issues.
Type the name of the new status of the environment
Select the new status of the environment
Update the url of the environment
Environment attribute values in key-value JSON format. Ex:
{
"OS" : "Linux",
"Location" : "Switzerland",
"Owner" : "[email protected]"
}Status of the action.
uses: apwide/golive-send-environment-info@main
with:
goliveToken: ${{ secrets.JRE_GOLIVE_TOKEN }}
githubToken: ${{ secrets.GITHUB_TOKEN }}
targetEnvironmentId: 488
deploymentVersionName: ECOM-2.2
deploymentIssueKeysFromCommitHistory: trueFollowing example is going to:
- if target environment, application and/or category do not exist, they will be created automatically. (target***AutoCreate)
- send deployment information to Golive including issue keys found in commits + overrident deploymentIssueKeys.
- if issues are linked to deployed version into Jira, they will be linked to the deployment too.
- issues will not have their fix version set with current deployed version.
- environment status will be set to Up
- environment url and attributes will be updated with provided information.
- no Jira notification will be sent for issue updates.
uses: apwide/golive-send-environment-info@main
with:
goliveToken: ${{ secrets.JRE_GOLIVE_TOKEN }}
githubToken: ${{ secrets.GITHUB_TOKEN }}
targetEnvironmentName: 'eCommerce Demo'
targetEnvironmentAutoCreate: true
targetApplicationName: 'eCommerce'
targetApplicationAutoCreate: true
targetCategoryName: 'Demo'
targetCategoryAutoCreate: true
deploymentVersionName: 'ECOM 2.3.4.45-Alpha'
deploymentBuildNumber: '$(Build.BuildNumber)'
deploymentDeployedDate: '2023-09-24T12:00:00Z'
deploymentDescription: |
** ✅ Job #$(Build.BuildId) - $(Build.DefinitionName)**
Requested by: $(Build.RequestedFor)
Branch: $(Build.SourceBranchName)
deploymentAttributes: |
{
"Requested By" : "[email protected]",
"Artefacts" : "https://binaries.company.com/download/232323",
"Repository" : "https://github.com/"
}
deploymentIssueKeys: 'ECOM-3412,ECOM-6783,PAY-98'
deploymentIssueKeysFromCommitHistory: true
deploymentIssuesFromJql: 'project = ECOM and type in (Story, Bug) AND resolution in (Fixed)'
deploymentAddDoneIssuesOfJiraVersion: true
deploymentNoFixVersionUpdate: false
deploymentSendJiraNotification: false
environmentStatusName: 'Up'
environmentUrl: 'https://ecommerce.staging.company.com'
environmentAttributes: |
{
"OS" : "Linux Ubuntu",
"Location":"Switzerland",
"Owner":"[email protected]"
}We are at your disposal if you have question or need support regarding Apwide Golive and this integration with Github: https://www.apwide.com/support-documentation/