{"id":29012,"date":"2025-10-16T11:27:47","date_gmt":"2025-10-16T11:27:47","guid":{"rendered":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/?page_id=29012"},"modified":"2025-10-16T21:13:30","modified_gmt":"2025-10-16T12:13:30","slug":"github","status":"publish","type":"page","link":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/github\/","title":{"rendered":"Integrate with GitHub"},"content":{"rendered":"<p>This article refers to integrating with <strong>GitHub Issues<\/strong>. If you&#8217;re looking for information about<\/p>\n<div class=\"callout callout--info\">\n<p>CI\/CD integrations, please see the documentation on <a href=\"\/test-automation\/ci-cd-tools-integration\/github-actions\/\" target=\"_blank\" rel=\"noopener\">Integratingwith GitHub Actions<\/a>.<\/p>\n<\/div>\n<p>TestRail integrates with GitHub so your team can link, view, add, and push issues between TestRail and GitHub as <a href=\"\/configuring-defect\/\" target=\"_blank\" rel=\"noopener\">bugs\/defects<\/a>, <a href=\"\/configuring-reference\/\" target=\"_blank\" rel=\"noopener\">requirements\/references<\/a>, or both. The TestRail integration with GitHub<br \/>supports the following use cases:<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-bullet\">\n<li><a href=\"#h_01HB6W7DZ4W177ZZX9BTG70WQH\">Link test cases to requirements <\/a><\/li>\n<li><a href=\"#h_01HB6W7DZ4FPC973Z2ZW9FQYMT\">Start creating requirements from TestRail<\/a><\/li>\n<li><a href=\"#h_01HB6W7DZ4JRBWZFS1QQZD14G4\">View requirements in TestRail<\/a><\/li>\n<li><a href=\"#h_01HB6W7DZ4NH80NDNZMDY8XNZ3\">Link defects to test results<\/a><\/li>\n<li><a href=\"#h_01HB6WEEZSNTAFBQ0NF2G622P5\">Submit new defects in GitHub<\/a><\/li>\n<li><a href=\"#h_01HB6WEEZSGRWTV4ND4XYEHJ3W\">Submit new defects from TestRail<\/a><\/li>\n<li><a href=\"#View_defects_in_TestRail\" target=\"_blank\" rel=\"noopener\">View defects in TestRail<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>You don\u2019t have to use all the listed integration options; you can mix and match the integration with other tools.<br \/>Configuring the integration usually only takes a few minutes. This guide explains how to configure the integration<br \/>and how it works.<\/p>\n\n\n<p><iframe loading=\"lazy\" src=\"\/\/www.youtube-nocookie.com\/embed\/r1R8E7-J61A\" width=\"700\" height=\"394\" frameborder=\"0\" allowfullscreen=\"\"><\/iframe><\/p>\n\n\n<h2 id=\"h_01HB6W7DZ4W177ZZX9BTG70WQH\">Link test cases to requirements<\/h2>\n<p>To set up test coverage, when you are creating or editing test cases, simply add one or more work item IDs (separated<br \/>by commas) to the <strong>References<\/strong> field.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_01.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_01.jpg\" alt=\"\" width=\"782\" height=\"364\" class=\"aligncenter size-full wp-image-29019\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_01.jpg 782w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_01-480x223.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 782px, 100vw\" \/><\/a><\/p>\n<p>The <strong>References<\/strong> you set in your test cases will be converted to a direct link to GitHub issues.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_02.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_02.jpg\" alt=\"\" width=\"779\" height=\"306\" class=\"aligncenter size-full wp-image-29020\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_02.jpg 779w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_02-480x189.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 779px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01HB6W7DZ4FPC973Z2ZW9FQYMT\">Start creating requirements from TestRail<\/h2>\n<p>GitHub issues can serve as a source of requirements, making them valuable references for test cases. TestRail offers a convenient <strong>Add<\/strong> link feature within the test case editor view, enabling seamless navigation to the GitHub issues screen. This feature expedites the process of creating new requirements that you wish to associate with your test cases. It&#8217;s important to remember that once you&#8217;ve created a new work item, you should copy and paste<br \/>its ID into the <strong>References<\/strong> field for proper traceability.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_03.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_03.jpg\" alt=\"\" width=\"779\" height=\"518\" class=\"aligncenter size-full wp-image-29022\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_03.jpg 779w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_03-480x319.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 779px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01HB6W4MPDYPE3HEZ7AT7E9B8J\">Configuring the Reference Add Url<\/h3>\n<p>To start creating new requirements from TestRail, you should configure the GitHub <strong>Reference Add Url<\/strong><br \/>in TestRail by following the steps below.<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-colored\">\n<li>Go to the <strong>Admin<\/strong>\u00a0page, select <strong>Integration<\/strong> to configure globally or <strong>Projects<\/strong> for a single project, and open the <strong>Reference<\/strong>s tab<\/li>\n<li>Insert your the<strong> Reference Add Url<\/strong> using the following pattern <code class=\"inline-code\">https:\/\/github.com\/&lt;OWNER&gt;\/&lt;REPOSITORY&gt;\/issues\/new<\/code><\/li>\n<li>Click <strong>Save Settings<\/strong><strong><br \/><\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_04.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_04.jpg\" alt=\"\" width=\"701\" height=\"217\" class=\"aligncenter size-full wp-image-29024\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_04.jpg 701w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_04-480x149.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 701px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01HB6W7DZ4JRBWZFS1QQZD14G4\">View requirements in TestRail<\/h2>\n<p>TestRail can retrieve additional information from IDs entered into the <strong>References<\/strong> field of TestRail entities, such as test cases, test runs, and milestones. Simply hover over the links and a dialog will show you all the latest information without having to navigate to GitHub.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_05.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_05.jpg\" alt=\"\" width=\"781\" height=\"470\" class=\"aligncenter size-full wp-image-29026\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_05.jpg 781w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_05-480x289.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 781px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01HB6FK1DQXQJJA7FRJXE61HQP\">Configuring the Reference Plugin<\/h3>\n<p>To view requirements directly in TestRail, you should configure the GitHub <strong>Reference Plugin<\/strong> in TestRail by following the steps below.<\/p>\n<ul class=\"list-colored\">\n<li style=\"list-style-type: none;\">\n<ul class=\"list-colored\">\n<li>Create a <a href=\"\/user-variables\/\" target=\"_blank\" rel=\"noopener\">User Variable<\/a> for the GitHub Personal Access Token (PAT)<\/li>\n<li>Go to the <strong>Admin<\/strong>\u00a0page, select <strong>Integration<\/strong> to configure globally or <strong>Projects<\/strong> for a single project, and open the References tab<\/li>\n<li>Select your <em>GitHub<\/em> variant in the Reference Plugin drop-down list<\/li>\n<li>Configure the connection settings in the <strong>[connection]<\/strong> section\n<ul class=\"list-bullet\">\n<li><strong>address<\/strong>: https:\/\/&lt;GitHub_URL&gt;\/<\/li>\n<li><strong>user<\/strong>: your username for Github<\/li>\n<li><strong>password<\/strong>: your <a href=\"\/user-variables\/\" target=\"_blank\" rel=\"noopener\">User Variable<\/a> for the<br \/>GitHub Personal Access Token (PAT)<\/li>\n<li><strong>owner<\/strong>: owner of the GitHub repository<\/li>\n<li><strong>name<\/strong>: name of the GitHub repository<\/li>\n<\/ul>\n<\/li>\n<li>Click <strong><strong>Save Settings<\/strong><\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<div class=\"callout callout--info\">\n<h4 id=\"h_01H8Y7NN1QXNRZATE4DT9A7BSW\" class=\"callout__title callout__icon\"><em class=\"fas fa-info-circle\"> <a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_06.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_06.jpg\" alt=\"\" width=\"706\" height=\"440\" class=\"aligncenter size-full wp-image-29028\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_06.jpg 706w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_06-480x299.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 706px, 100vw\" \/><\/a><\/em><\/h4>\n<p>To generate a GitHub API token in your GitHub account, click on <strong>Settings<\/strong>, then<strong> Developer Settings<\/strong>. Then click on <strong>Personal Access Tokens<\/strong> in the left menu. Click <strong>Generate new token<\/strong>.<\/p>\n<\/div>\n<h2 id=\"h_01HB6W7DZ4NH80NDNZMDY8XNZ3\">Link defects to test results<\/h2>\n<p>The <strong>Defect View URL<\/strong> is used to build a link to GitHub based on the Defect ID, so you can simply click on an ID to open the issue directly in GitHub.<\/p>\n<p>When you set up the Defect View URL integration with GitHub Issues, you can paste the ID of a GitHub issue in the Defects field of a test result and TestRail will automatically convert that ID into a clickable link to view the issue in GitHub. This allows your team to link tests with GitHub issues and create defect and traceability reports in TestRail.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_07.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_07.jpg\" alt=\"\" width=\"773\" height=\"554\" class=\"aligncenter size-full wp-image-29032\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_07.jpg 773w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_07-480x344.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 773px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01HB6FK1DQXQJJA7FRJXE61HQP\">Configuring the Defect View Url<\/h3>\n<p>To link defects to test results in TestRail, you should configure the GitHub Defect View Url in TestRail by following the steps below.<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-colored\">\n<li>Go to the <strong>Admin<\/strong>\u00a0page, select <strong>Integration<\/strong> to configure globally or <strong>Projects<\/strong> for a single project, and open the <strong>Defects<\/strong> tab<\/li>\n<li>Insert your <strong>Defect View Url<\/strong> using the following pattern <code class=\"inline-code\">https:\/\/github.com\/&lt;OWNER&gt;\/&lt;REPOSITORY&gt;\/issues\/%id%<\/code><\/li>\n<li>Click <strong>Save Settings<\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><strong>Note<\/strong> : Please make sure to replace <code class=\"inline-code\">&lt;OWNER&gt;<\/code> and <code class=\"inline-code\">&lt;REPOSITORY&gt;<\/code>with the actual repository and the owner name in GitHub you want to integrate with.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_08.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_08.jpg\" alt=\"\" width=\"782\" height=\"231\" class=\"aligncenter size-full wp-image-29035\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_08.jpg 782w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_08-480x142.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 782px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01HB6WEEZSNTAFBQ0NF2G622P5\">Submit new defects in GitHub<\/h2>\n<p>TestRail provides quick navigation to report defects using the GitHub interface. You can do it from two different places &#8211; the <strong>Defects menu<\/strong> and the <strong>Add Test Result dialog<\/strong>.<\/p>\n<p>The <strong>Defects menu<\/strong>, also known as TestRail\u2019s <a href=\"\/configuring-defect\/#i-9\" target=\"_blank\" rel=\"noopener\">Defect From Anywhere<\/a> feature, is displayed on top of most pages for quick access.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_09.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_09.jpg\" alt=\"\" width=\"776\" height=\"286\" class=\"aligncenter size-full wp-image-29039\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_09.jpg 776w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_09-480x177.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 776px, 100vw\" \/><\/a><\/p>\n<p>The <strong>Add Test Result dialog<\/strong> displays the <strong>Add link<\/strong> next to the <strong>Defects field<\/strong> for quickly and conveniently navigating to GitHub in order to submit a defect when your test is failing.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_10.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_10.jpg\" alt=\"\" width=\"774\" height=\"598\" class=\"aligncenter size-full wp-image-29041\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_10.jpg 774w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_10-480x371.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 774px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01HB6FK1DQXQJJA7FRJXE61HQP\">Configuring the Defect Add Url<\/h3>\n<p>To quickly navigate to GutHub to create a new defect, you should configure GitHub Defect Url in TestRail by following the steps below.<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-colored\">\n<li>Go to the <strong>Admin<\/strong>\u00a0page, select <strong>Integration<\/strong> to configure globally or <strong>Projects<\/strong> for a single project, and open the <strong>Defects<\/strong> tab<\/li>\n<li>Insert your <strong>Defect Add Url<\/strong> using the following pattern <code class=\"inline-code\">https:\/\/github.com\/&lt;OWNER&gt;\/&lt;REPOSITORY&gt;\/issues\/new<\/code><\/li>\n<li>Click <strong><strong>Save Settings<\/strong><\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_11.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_11.jpg\" alt=\"\" width=\"781\" height=\"233\" class=\"aligncenter wp-image-29043 size-full\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_11.jpg 781w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_11-480x143.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 781px, 100vw\" \/><\/a><\/p>\n<p>Note : Please make sure to replace <code class=\"inline-code\">&lt;OWNER&gt;<\/code> and <code class=\"inline-code\">&lt;REPOSITORY&gt;<\/code> with the actual repo and the owner name in GitHub you want to integrate with.<\/p>\n<h2 id=\"h_01HB6WEEZSGRWTV4ND4XYEHJ3W\">Submit new defects from TestRail<\/h2>\n<p>To enhance the seamless integration of defect reporting, TestRail offers a pre-configured GitHub defect plugin. This plugin empowers you to effortlessly submit new issues to GitHub directly from within TestRail.<\/p>\n<p>By utilizing the intuitive <strong>Push Defect dialog<\/strong>, you can swiftly generate a fresh defect complete with a title, description, and any additional fields that GitHub supports. This streamlined process ensures a smoother<br \/>defect management workflow.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_12.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_12.jpg\" alt=\"\" width=\"779\" height=\"674\" class=\"aligncenter size-full wp-image-29045\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_12.jpg 779w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_12-480x415.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 779px, 100vw\" \/><\/a><\/p>\n<p>You can open the defect submission dialog from two places &#8211; the <strong>Defects menu<\/strong> and the <strong>Add Test Result dialog<\/strong>.<\/p>\n<p>The <strong>Defects menu<\/strong>, also known as TestRail\u2019s <a href=\"\/configuring-defect\/#i-9\" target=\"_blank\" rel=\"noopener\">Defect From Anywhere<\/a> feature, is displayed on top of most pages for quick access.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_13.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_13.jpg\" alt=\"\" width=\"784\" height=\"282\" class=\"aligncenter size-full wp-image-29048\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_13.jpg 784w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_13-480x173.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 784px, 100vw\" \/><\/a><\/p>\n<p>The<strong> Add Test Result dialog<\/strong> displays the <strong>Push link<\/strong> next to the <strong>Defects field<\/strong> to efficiently report a defect while you&#8217;re submitting your test results.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_14.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_14.jpg\" alt=\"\" width=\"782\" height=\"607\" class=\"aligncenter size-full wp-image-29049\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_14.jpg 782w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_14-480x373.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 782px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01HB6FK1DQXQJJA7FRJXE61HQP\">Configuring the Defect Plugin<\/h3>\n<p>To submit new defects straight from TestRail, you should configure the GutHub <strong>Defect Plugin<\/strong> in TestRail by following the steps below.<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-colored\">\n<li>Go to the <strong>Admin<\/strong>\u00a0page, select <strong>Integration<\/strong> to configure globally or <strong>Projects<\/strong> for a single project, and open the References tab<\/li>\n<li>Select your <em>GitHub<\/em> variant in the Reference Plugin drop-down list<\/li>\n<li>Configure the connection settings in the <strong>[connection]<\/strong> section\n<ul class=\"list-colored\">\n<li><strong>address<\/strong>: https:\/\/&lt;GitHub_URL&gt;\/<\/li>\n<li><strong>user<\/strong>: your username for GitHub<\/li>\n<li><strong>password<\/strong>: your GitHub personal access token ( PAT)<\/li>\n<li><strong>owner<\/strong>: owner of the GitHub repository<\/li>\n<li><strong>name<\/strong>: name of the GitHub repository<\/li>\n<\/ul>\n<\/li>\n<li>Click <strong><strong>Save Settings<\/strong><\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_15.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_15.jpg\" alt=\"\" width=\"968\" height=\"450\" class=\"aligncenter size-full wp-image-29052\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_15.jpg 968w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_15-480x223.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 968px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01HB6WEEZSBFRCSNF50VK5ZESH\">View defects in TestRail<\/h2>\n<p>Simply hover over defect links and a dialog will show you all the latest information without having to navigate to GutHub. These links are available in the test results directly, as well as the Defects section on test runs, test<br \/>plans and milestones.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_16.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_16.jpg\" alt=\"\" width=\"797\" height=\"399\" class=\"aligncenter size-full wp-image-29053\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_16.jpg 797w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_16-480x240.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 797px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01HB6FK1DQXQJJA7FRJXE61HQP\">Configuring the Defect Plugin<\/h3>\n<p>To submit new defects straight from TestRail, you should configure the GitHub <strong>Defect Plugin<\/strong> in TestRail by following the steps below.<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-colored\">\n<li>Go to the <strong>Admin<\/strong>\u00a0page, select <strong>Integration<\/strong> to configure globally or <strong>Projects<\/strong> for a single project, and open the References tab<\/li>\n<li>Select your <em>GitHub<\/em> variant in the Reference Plugin drop-down list<\/li>\n<li>Configure the connection settings in the <strong>[connection]<\/strong> section\n<ul class=\"list-colored\">\n<li><strong>address<\/strong>: https:\/\/&lt;GitHub_URL&gt;\/<\/li>\n<li><strong>user<\/strong>: your username for GitHub<\/li>\n<li><strong>password<\/strong>: your GitHub personal access token (PAT)<\/li>\n<li><strong>owner<\/strong>: owner of the GitHub repository<\/li>\n<li><strong>name<\/strong>: name of the GitHub repository<\/li>\n<\/ul>\n<\/li>\n<li>Click <strong><strong>Save Settings<\/strong><\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<div class=\"callout callout--info\">\n<h4 id=\"h_01H8Y7NN1QXNRZATE4DT9A7BSW\" class=\"callout__title callout__icon\"><em class=\"fas fa-info-circle\"> <a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_17.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_17.jpg\" alt=\"\" width=\"968\" height=\"450\" class=\"aligncenter size-full wp-image-29054\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_17.jpg 968w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_17-480x223.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 968px, 100vw\" \/><\/a><\/em><\/h4>\n<p>To generate a GitHub API token in your GitHub account, click on <strong>Settings<\/strong>, then<strong> Developer Settings<\/strong>. Then click on <strong>Personal Access Tokens<\/strong> in the left menu. Click <strong>Generate new token<\/strong>.<\/p>\n<\/div>\n<p>It is also possible to customize the fields that appear via link hovering. You can see more information on how to do it on the <a href=\"\/example-custom-plugin\/\" target=\"_blank\" rel=\"noopener\">Customizing the Requirement\/Defect Plugins<\/a> section.<\/p>\n<h2 id=\"h_01H8Y9P5D39WNYGJWSEFBN925Z\">Advanced customizations<\/h2>\n<h3 id=\"h_01H8YC0HD6K9KGTYG9D7JJ69QH\">User variables<\/h3>\n<p>We recommend using <a href=\"\/user-variables\/\" target=\"_blank\" rel=\"noopener\">User Variables<\/a> when configuring any integration credentials. This allows you to provide generic credentials without disclosing them, and also lets users define their own credentials in their personal<br \/>settings, for better access control. Below you can see an example of how to set variables in your configuration.<\/p>\n<pre><code class=\"shell\">user=%github_username%\npassword=%github_password%<\/code><\/pre>\n<p><\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_18.jpg\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_18.jpg\" alt=\"\" width=\"858\" height=\"447\" class=\"aligncenter size-full wp-image-29055\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_18.jpg 858w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/Capture_github_18-480x250.jpg 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 858px, 100vw\" \/><\/a><\/p>\n<h3 id=\"customizing_defect_plugins\" class=\"sectionedit3\">Customizing the Requirement\/Defect Plugins<\/h3>\n<p>The GitHub plugin was built to work with a standard GitHub configuration. TestRail allows you to customize the fields which appear in the Push dialog as well as when hovering over work item IDs, both for requirements and defects.<br \/>Preconfigured push fields and hover fields can be set to <code class=\"inline-code\">on<\/code> or <code class=\"inline-code\">off<\/code> in their respective <code class=\"inline-code\">[push.fields]<\/code> and <code class=\"inline-code\">[hover.fields]<\/code> sections, and you can also change their order, which will be reflected in the UI.<\/p>\n<div class=\"callout callout--info\">\n<p id=\"h_01H8Y7NN1R9F9GWK3VMEWT8YZJ\" class=\"callout__title callout__icon\">Some fields (such as the title) are always enabled and may not appear in these sections due to always being required by either TestRail or GitHub.<\/p>\n<\/div>\n<p>In addition to enabling, disabling, or re-organizing fields as described above, it\u2019s also possible to change additional options per field. To do this, you would define a section for the field, such as <code class=\"inline-code\">[push.field.description]<\/code> and specify additional options within this section.<\/p>\n<pre><code class=\"config\">[push.field.description]\nlabel=Detailed Description\nrequired=true<\/code><\/pre>\n<p>Please see below for full list and explanation of the available field options:<\/p>\n<table class=\"table table--hover\" style=\"border-collapse: collapse; width: 100%;\">\n<thead>\n<tr>\n<th style=\"width: 20.2857%;\"><strong>Option<\/strong><\/th>\n<th style=\"width: 79.5714%;\"><strong>Description<\/strong><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"width: 20.2857%;\"><code class=\"inline-code\">label<\/code><\/td>\n<td style=\"width: 79.5714%;\">Specifies the display name of the field in the Push Defect<br \/>dialogue\u00a0<em>(Required for custom fields)<\/em><\/td>\n<\/tr>\n<tr>\n<td style=\"width: 20.2857%;\"><code class=\"inline-code\">size<\/code><\/td>\n<td style=\"width: 79.5714%;\">Specifies whether the field is displayed as a compact field <code class=\"inline-code\">(compact)<\/code> or uses the full width of the dialogue <code class=\"inline-code\">(full)<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"width: 20.2857%;\"><code class=\"inline-code\">remember<\/code><\/td>\n<td style=\"width: 79.5714%;\">Specifies if previously selected values for this field should be remembered and<br \/>restored the next time the Push Defect dialogue is opened<\/td>\n<\/tr>\n<tr>\n<td style=\"width: 20.2857%;\"><code class=\"inline-code\">required<\/code><\/td>\n<td style=\"width: 79.5714%;\">Specifies if this field is mandatory or optional and whether users are required<br \/>to enter a value for this field in the Push Defect dialogue<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"reference_urls\" class=\"sectionedit5\">Attachments<\/h4>\n<p>The GitHub Defect Plugin supports submitting attachments to GitHub as well. This field can be turned on and off, but cannot be customized. To submit one or more attachments to GitHub, simply drag the attachment to the attachments or description areas of the push dialog or click on the area to choose an attachment from your file system.<\/p>\n<p><!-- START note --><\/p>\n<div class=\"callout callout--info\">\n<p id=\"h_01HBB3JWQVRTEVPRPRYVJ5VS8V\" class=\"callout__title callout__icon\">To enable attachments in the push dialog, add \u2018attachments=on\u2019 to the <code class=\"inline-code\">[push.fields]<\/code> section of the Defect Plugin\u2019s settings.<\/p>\n<\/div>\n<p><!-- END note --><\/p>","protected":false},"excerpt":{"rendered":"<p>This article refers to integrating with GitHub Issues. If you&#8217;re looking for information about CI\/CD int [&hellip;]<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":6734,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","footnotes":""},"class_list":["post-29012","page","type-page","status-publish","hentry"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/29012","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/comments?post=29012"}],"version-history":[{"count":30,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/29012\/revisions"}],"predecessor-version":[{"id":29061,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/29012\/revisions\/29061"}],"up":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/6734"}],"wp:attachment":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/media?parent=29012"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}