Configuring Github integration

With NeetoPlaydash, you can integrate your GitHub repository to receive test run results directly in your pull requests (PRs). The results will appear as comments within the PR, while the live test status will be displayed as commit statuses. To connect Github with NeetoPlaydash, you need to connect your Github organization and the Github repository.

To connect your Github organization:

  1. Click on the Settings menu.

    Screenshot 2024-09-20 at 4.14.00 PM.png
    Dashboard | Settings menu
  2. Click on the Github integrations card.

    Screenshot 2024-09-20 at 4.28.08 PM.png
    Settings page
  3. Click on the Connect Github account button.

    Screenshot 2024-09-20 at 4.31.53 PM.png
    Github integrations page
  4. In the Github app installation page, select the organization you want to connect with.

    Screenshot 2024-09-20 at 5.06.05 PM.png
    Github app installation page
  5. [Optional] Choose the repositories to which you want to grant access.

    github.com_apps_neetoplaydash_installations_new_permissions_target_id=47653646&target_type=User.png
    Github app permissions page
  6. Verify the permissions and click on the install button.

    github.com_apps_neetoplaydash_installations_new_permissions_target_id=47653646&target_type=User.png
    Github app permissions page | Installation
  7. This will install the application and redirect to the Github integrations page where you will see the account you installed listed on the page.

    Screenshot 2024-10-07 at 7.33.38 PM.png
    Github integrations page | Connected organization

To connect and configure the Github repository:

  1. Choose the project for which you want to send Slack notifications.

    Screenshot 2024-09-20 at 3.53.13 PM.png
    Projects dashboard
  2. Click the Configure tab to go to the project configuration menu.

    Screenshot 2024-10-09 at 2.58.52 PM.png
    Project detail page
  3. In the project configuration screen, click on the Github card. This will open the Github configuration page.

    Screenshot 2024-10-09 at 3.19.43 PM.png
    Project Configuration
  4. In the Github configuration page, click on the Manage Github button. This will start the Github configuration wizard.

    Screenshot 2024-10-09 at 3.34.27 PM.png
    Github configuration
  5. Choose Github repository: In the Github configuration wizard, choose the repository which you want to connect with the project. Once the repository has been selected, click on the Continue button.

    Screenshot 2024-10-09 at 3.53.35 PM.png
    Github configuration | Select repository
  6. Add trigger events: The step is optional. In this step, you can configure the events that trigger the Github notifications. These events include the branch name pattern and the tag pattern. Notifications will only be triggered for runs matching the configured patterns. The inputs support both plain string and regular expressions for additional flexibility.

    This means that a branch pattern prod will match the branch names:

    • prod

    • production

    • new-prod

    • prod1

    You can provide a pattern for the git branch name as well as for the tags for the Playwright runs.

    Screenshot 2024-09-04 at 11.56.42 PM.png
    Github configuration | Trigger events step

    You can also test the patterns you provided against some known values of branch names and tags by clicking on the Test your Pattern buttons on the respective fields.

    Screenshot 2024-09-05 at 12.03.13 AM.png
    Pattern test with a non-matching branch name

    Screenshot 2024-09-05 at 12.02.50 AM.png
    Pattern test with a matching branch name

    Once the patterns have been entered click on the Continue button to move to the next step.

    If no changes have been made, notifications will be sent for all runs.

  7. Configure template: The step is optional. Configure the template for the Github notification you would like to see on the page. A set of predefined dynamic variables is available for you to customize the Github notification according to your needs. A live preview of how the final Github comment would look will be seen on the right-hand side of the page. Once you're satisfied with how the message looks, click on the continue button to move to the next step.

    If no changes have been made, the notifications will be sent with the default template.

    Screenshot 2024-10-09 at 5.04.41 PM.png
    Github configuration | Configure template
  8. Configure commit status: The step is optional. NeetoPlaydash has the ability to add commit statuses in Github. To enable commit status, enable the Send commit status switch.

    Screenshot 2024-10-09 at 5.10.11 PM.png
    Github configuration | Enable commit status

    Once enabled, you will be able to customize the commit status message. Once done, click on the Continue button to move to the next step.

    Screenshot 2024-10-09 at 5.13.31 PM.png
    Github configuration | Customize commit status
  9. Notification preferences: This is an optional step. enable on the Send Github notification only for failed runs switch to send Github notification only for failed runs. Click on the Continue button to continue to the last step.

    Screenshot 2024-10-09 at 8.17.37 PM.png
    Github configuration | Notify only failed runs
  10. In the last step, click on the Finish button to complete the setup.

Demo

NeetoPlaydash Github notification demo

Can't find what you're looking for?