The GitHub Connector allows IT teams to seamlessly integrate GitHub functionalities into your Multiplier workflows.
This integration enables you to automate workflows, retrieve information, and manage your GitHub resources directly from Multiplier, including:
Organization and repository management
Project and team administration
User access control and permissions
What can I do with GitHub + Multiplier?
Grant repo access and team membership from Jira
Log who had which permissions, for how long, and why
Setup in GitHub
This connector requires a classic API Token. A GitHub admin will need to generate a new classic token.
Creating a GitHub token
You can create a GitHub classic token, required to connect Multiplier with your GitHub instance, by following the steps listed below:
Log in to your GitHub instance as an administrator.
Click your avatar and select the Settings option from the side menu.
3. Go to Developer settings, following the link located in the left sidebar near the bottom.
4. Click Personal access tokens on the left sidebar and select "Tokens (classic)".
5. Click the "Generate new token" button and select "Generate new token (classic)".
6. Enter a name, duration, and enable the required scopes. You can check what scope is required for each feature in the "Required Scopes" section.
7. Click the "Generate token" button, and copy the generated token. You will not be able to see it again in GitHub.
Setting up the integration
To setup the integration, simply paste the token generated in the steps above, and click the "Connect to GitHub button"
Required scopes
Each action provided by the GitHub integration require a different scope. If you don't want to enable all of them, you can select the ones you need according to the actions you'll implement.
Remove user from organization:
admin:orgRemove user from team:
admin:orgAdd user to team:
admin:orgInvite user to organization:
admin:orgBlock user from organization:
admin:orgInvite collaborator to repository:
repo:invite, read:orgAdd project collaborator:
project
Note that the integration requires at least user:email and read:org to be enabled in order to work.
Portal fields
The GitHub Connector supports Multiplier's portal fields that integrate with GitHub entities such as organizations, repositories, projects, and teams. To learn how to add a portal field, please see Using Portal Fields to insert external data in your Jira forms.
These fields enable the creation of tickets that automatically initiate actions, facilitating efficient interaction with the specified GitHub resources.
Some portal fields may require additional configuration settings. For example, a repository portal field will need to have an organization selected. This ensures that the field displays repositories specific to the chosen organization.
Following the example, when creating a portal field to expose a list of repositories, you will be prompted to select the organization from which repositories come.
Note that when configuring an action that uses a portal field value that has a common dependency, its value should match.
Post Function
Once your portal field has been set up, you will need to use the Github Post Function provided by Multiplier to trigger actions such as adding adding a collaborator to a repository. To look at an example of how these post functions work, refer to this article on automating access to Jira projects.
The portal will display a portal field to let the user select a repository, and that repository will be used by an action that requires knowing the repository and the organization. In this case, the organization should be set to the same value used by the portal field.
