Git2Gus Application

Ready to use Git2Gus?

Getting started to use Git2Gus is simple. Go through the following 3 steps:

1. 

   1. Install Git2Gus application

   Navigate to https://github.com/apps/git2gus and install the app in you repo.

2. 

   2. Commit the configuration file into your 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"
   }
                           

3. 

   3. Enjoy the syncronization.

   Since the app was installed and the config file is in then the app is going to start reacting to events on the issues.

Configuring Git2Gus

• productTag The unique ID of the productTag used by your team in Salesforce. When a new work item is going to be created this is the id the application is going to use. To see your Product Tags go to the App Launcher in Salesforce and search "product tags".
• productTagLabels Custom productTags you can assign to work items via labels. If a work item has a label corresponding to a key in productTagLabels, it will use that productTag instead of the default productTag.
If a default productTag isn't provided in your config (ex: if the line "productTag": "a1aB0000000Jgm7IAC" wasn't there) and no matching productTagLabel is found, the work item will not be synced. In the example below, the GitHub label "area:lwc" corresponds to the productTag "1234".

                
                {
                    "productTag": "a1aB0000000Jgm7IAC",
                    "productTagLabels": { "area:lwc": "1234", "area:aura": "3456" },
                    "issueTypeLabels": { "feature": "USER STORY", "urgent": "BUG P0" },
                    "defaultBuild": "218"
                }
                
            

• issueTypeLabels Labels you can assign to certain issue types. You can specify labels to replace or join the default labels provided: BUG P0, BUG P1, BUG P2, BUG P3, USER STORY, INVESTIGATION P0, INVESTIGATION P1, INVESTIGATION P2, INVESTIGATION P3. Note that these are case and space sensitive.
• defaultBuild The build number the application is going to use by default when it creates a new work item. Notice this value might need to be changed every release.
• statusWhenClosed It allows to specify the status `INTEGRATE`, `FIXED` or `CLOSED` of the work item when the Github issue gets closed. By default: `INTEGRATE`.
• hideWorkItemUrl Some repositories are private or open source, when your repository is open source exposing internal urls is a security vulnerability. You will need to set this option to `true` in order to hide the url and use the WI-# instead. By default: `false`.

How Git2Gus works?

Creating work items automatically.

Link issue with an existing work item.

Closing work items automatically.