the GitHub app can be used for issue tracking and for starting your GitHub automated workflows from case to install the app navigate to the apps section of your workspace you'll see the app under continuous integration or under issue tracking click on the app and install now you'll be redirected to a GitHub login screen enter your credentials to login and on this page either select all repositories or you can select specific repositories I'm going to select all for now click on install the next step is to authorize GitHub to access your case workspace let's look at
the issue tracking features of the GitHub app you can link your test cases and test runs to a GitHub issue you can also file a GitHub issue directly from within the case test run to link a test case go to the property section of the test case scroll down to find the link GitHub app issues button select your repository and search for an issue to link to unlink simply remove the issue from this section similarly for test runs in the testr Run dashboard to the bottom right under external issue select select the integration as GitHub
and then proceed to search and Link the issue to the test run to file a GitHub issue from within a test run add any negative result to a test case and check the attach or create defect option in the next screen under Integrations select the GitHub app on this screen the title and description are prepopulated from your test case title steps description and preconditions finally select your GitHub repository and then click on create you can view this defect from the defects tab of the run this here is the defect we've just filed and it's hyperlink
to the issue on GitHub the issue on GitHub also contains a direct link to the corresponding case defect as well as the test run the defect is from the issue statuses on both case and GitHub are synchronized so if you change the case defect status as resolved the corresponding GitHub issue will have its status changed let's now look at the cicd functionality of the GitHub app to start an automated test run click on the start a new test run button change the type from manual to automated next select the GitHub app and proceed to choose
your repository branch and the workflow once you start the Run case will trigger the workflow in your GitHub actions you can see the build with its hyperlink here currently it's in progress clicking on this will take you to your GitHub actions page once the build is complete and the tests are run you'll see the results posted to the same test run other relevant details such as the start time the end time and the duration of the Run are also available here please note starting an automated run will only trigger your workflow on GitHub but you
will still need an API reporter installed and configured for collecting all the results of those executed tests and Reporting them back to case in this example we have the Cypress reporter configured now we'll look at configuring your workflow yam on GitHub you can start by selecting any of the available API reporters from the app section click on the app and open the guide to find instructions and configuration options for the specific reporter to connect your GitHub workflow with case follow the instructions from the cicd section of the help article for GitHub as mentioned earlier we
first need an AP AP reporter configured then the next step is to create an API token by going to this link it'll take you to this page where you can create your API token you can also get to this page by clicking on your profile picture and selecting API tokens once you have the token on your GitHub repository go to the settings page for the repository and from there under secrets and variables select actions then under secrets and repository Secrets add a secret with the name case API token the final step is to add these
exact blocks of code to your workflow yaml on GitHub this will link your case test run with the workflow please ensure to add this Step at the first place in the job before any other steps you may have in The Help article you can find an example and some additional resources to help you set up your workflow if you have more questions on this or any other feature you can check out our help articles in our FAQ section if you do not find an answer to your question or if you have any feedback that you'd
like to share with us just drop us a message [Music]
