Skip to main content
Skip table of contents

Integrate TestRail with GitHub

Integrating TestRail and GitHub allows you to link test results to GitHub tickets. You can report, create, and push new defect tickets from TestRail while executing a test case. Within TestRail, you can also preview information in the corresponding ticket in GitHub.

To integrate TestRail with GitHub, follow the steps below:

Before you begin

To integrate TestRail and GitHub, you need access to a TestRail account. If you do not have a TestRail account, request help in #vfs-platform-support. For more information about requesting support, see Get help from the Platform in Slack.

Integrating TestRail with GitHub

  1. Go to your GitHub fine-grained personal access tokens.

  2. Select Generate new token to create a new access token for personal TestRail integration.

  3. Add a meaningful token name.

    Add a meaningful name for the Token name field

    Add a name for your new token

  4. Adjust the expiration of the token as desired

    Adjust the expiration of the token

    Adjust the expiration of the token

  5. Adjust the resource owner to department-of-veteran-affairs

    Adjust the resource owner to department-of-veteran-affairs

    Change the resource owner

  6. Under repository access, choose the Only select repositories radio option and select department-of-veteran-affairs/ from the dropdown

    Search for or scroll down and select the repository

    Most VFS teams have user stories and defects in

  7. Click the Repository permissions area to expand it and scroll down to issues

  8. Click the Access: No access dropdown and select read and write

    Add read and write permissions for to the token

    Add read and write permissions for to the token

  9. Click Generate token

  10. Select the copy button next to your token to store it on your clipboard.

    Copy the token into your clipboard by clicking the button

    Click the copy button

  11. Go to the TestRail My Settings page.

  12. Select the Settings tab at top of page.

    Select the Settings tab

    Select the Settings tab

  13. Enter your GitHub username into the GitHub User input box.

  14. Enter the GitHub token stored on your clipboard into the GitHub Password input box.

    Enter username and token in TestRail My Settings page

    My Settings page

  15. Select the Save Settings button.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.