Integration Creation
Choosing Authentication type
Next, let’s decide which Authentication option is best for you. You can choose either PAT or OAuth based authentication with full featured integrations, but please note that the availability of authentication options can vary by Git service. Functionally, in most cases both options will work, without much difference.
If it is available, we recommend OAuth authentication, as this allows some automatic actions to be taken by GIJ depending on the permissions level of the account used as well as the Git service. In some cases, this will allow GIJ to automatically create indexing triggers for your repositories, saving you some time and effort.
PAT authentication tends to be easier to maintain on an organizational level, especially when using multiple service accounts, as the Git Service Admins should have easy access to the accounts to generate the PATs. For detailed instructions on how to create Personal Access tokens, please see Creating Personal Access Tokens.
Creating your Integrations
Ready for the fun part? It is time to create your integrations! For detailed step by step instructions on how to create the integrations by Git service, please refer to our Integration Guides. Please see the Webhook Indexing Integration Guides for detailed instruction for the support Git services.
All of the planning and decision making from the previous steps get put to work during the integration creation process. You should now have confidence choosing your authentication type, which repositories to include, and which Project Association permissions to apply to limit visibility.
If using multiple integrations, consider creating only one or two integrations at a time. Additionally, please wait until the initial indexing phase completes for the new integration before going through the process of creating the next one. This reduces the probability of rate limiting issues or overloading the application with a large backlog of tasks.
While this suggested approach may take a bit longer to complete, it avoids common issues or quickly raises important issues to address before committing the time to create all of your integrations. For any such issues, contact our support team to work through the problem and save time.
Post Integration creation configuration
Now that you have created all of your integrations, we recommend the following actions to round out your configuration.
Edit Integration feature settings
Display Name
We suggest editing each of your integrations and modifying the display name to better reflect what is included, or what org/group is connected.
Require user PAT
We strongly recommend enabling the “require user PAT” integration setting. This option will require all of your users to provide their own PAT the first time they go to create a branch or pull/merge request from inside Jira.
This is important, as we will then use their PAT to authenticate newly created branches and pull/merge requests and attribute them to the correct user on your Git Service. If this option is not enabled, the branch/pull/merge request will still be created, but it will be authenticated using the integration connection credentials, and will be attributed to whatever account the credentials are associated with. Please see Require Personal Access Tokens for further details.
