Getting started to use Git2Gus is simple. Go through the following 3 steps:
Navigate to https://github.com/apps/git2gus and install the app in you repo.
In order to customize your repo for your team you have to commit a configuration file .git2gus/config.json with specific data about your team. e.g.
{
"productTag": "a1aB0000000Jgm7IAC",
"defaultBuild": "218"
}
Since the app was installed and the config file is in then the app is going to start reacting to events on the issues.
{
"productTag": "a1aB0000000Jgm7IAC",
"productTagLabels": { "area:lwc": "1234", "area:aura": "3456" },
"issueTypeLabels": { "feature": "USER STORY", "urgent": "BUG P0" },
"defaultBuild": "218"
}
1. Add a Salesforce label to the issue.
When the application gets installed in your repo, a set of labels are added automatically. USER STORY, BUG P0, BUG P1, INVESTIGATION P0, etc. Adding a label to a Github issue is going to automatically create a GUS work item and keep the new ticket in sync with the Github issue. The USER STORY label will create a User Story work item, BUG priority labels will create a Bug work item, and INVESTIGATION priority labels will create an Investigation work item
2. The new work item
The new work item is going to be created using the priority, title and description fields specified in the Github issue. Also the FoundInBuild and the ProductTag fields are going to be equal to the values provided in the configuration file.
1. Add the annotation @W-1234567@ into the issue description.
Add the @W-1234567@ annotation in the issue description where W-1234567 is the name of the work item you want to link.
2. The Issue and work item are linked.
When an issue gets linked to an existing work item it means that when the issue gets closed the work item in Salesforce it's going to be closed as well.
1. Close an issue.
Closing Github issues that were linked to work items will trigger that the work item closes automatically.
2. Change work item status
Work items that close automatically are going to have status specified in the config, or 'INTEGRATE' by default