A GitHub integration enables the following features in YouTrack:
- Apply commands to YouTrack issues right from a commit comment or a pull request description. For more information, see Apply Commands in VCS Commits.
- Add links to YouTrack issues in commit messages. For more information, see Link Issues in VCS Commits.
- Add links to the GitHub repository by pasting commit hashes into the summary, description, comment, or string-type custom field in YouTrack issues.
- Your YouTrack server must be accessible from the Internet.
- A committer's email address in YouTrack must be the same as in GitHub. YouTrack searches for a user account based on the email address that is registered in GitHub. These users must also have permission to update issues in the connected YouTrack project. If no match is found or the user does not have the required permission, the commands are not applied.
Configure the GitHub Integration
When you enable and configure the GitHub integration, you define mappings between a YouTrack project and a GitHub repository.
As an administrator, you can enable the GitHub integration for any project in YouTrack.
To enable and configure the GitHub integration:
- Open the page.
- Click the New VCS Integration button.
- From the Server drop-down list, select github.com.
- Generate an OAuth token in GitHub:
- Paste the token in the OAuth Token field.
- If you are not the repository owner, provide the repository owner name. If you are the owner of the repository, leave the field blank.
- Click the Connect to VCS server button.
- Enter values for the following settings:
- Click the Save button.