Skip to main content

GitHub Sync

Overview​

GitHub Sync allows you to keep your SmartTests synchronized between TestChimp and your GitHub repository. This enables version control, collaboration, and integration with your existing development workflow. Sync is branch-aware: you choose which branch to sync against, and content stays in sync for that branch.

Branch-Aware Sync​

Sync is branch-aware. You can select which branch to sync against:

  • Select a branch: In the sync configuration, choose the branch you want to work with (e.g. main, develop, or a feature branch like feature/login-redesign).
  • Content stays in sync for that branch: All sync operations—push and pull—apply to the selected branch. TestChimp keeps the SmartTests folder content aligned with that branch.
  • PRs are raised for that branch: When you make changes in TestChimp, pull requests are created targeting the branch you are synced to, so review and merge follow your normal workflow.

This enables shift-left and direct QA involvement in feature development:

  • QAs can author tests on feature branches: Test authors work against the same branch as developers, so tests are written for the code that is being built.
  • Tests run against branch preview URLs: Once you configure branch-specific endpoints, tests and explorations can run against PR preview / deployment preview URLs for that branch.
  • Find issues before merge: Run SmartTests and exploratory runs against the branch deployment, so UX, performance, accessibility, and other issues are found before the branch reaches the default branch.

Setting Up GitHub Sync​

  1. Navigate to your SmartTests folder in TestChimp
  2. Click on the branches icon in the left pane (version control integration button)
  3. Configure the sync settings:
    • Select your GitHub repository
    • Choose the folder in your codebase to sync with
    • Select the branch you want to sync against

Sync is bidirectional by default - changes flow both ways between TestChimp and GitHub for the selected branch.

Syncing Test Folders​

Once configured, your test folder in TestChimp will be synchronized with the selected folder in your GitHub repository for the selected branch:

  • Changes in TestChimp are automatically synced to GitHub (as commits/PRs on that branch)
  • Changes in GitHub on that branch can be pulled into TestChimp
  • Tests remain in sync for that branch across both platforms

To run tests against branch-specific deployment URLs (e.g. PR previews), configure Branch Specific Test Execution.

Benefits of GitHub Sync​

  • Version control: All your SmartTests are versioned in Git
  • Branch-aware workflow: Sync and author tests on the same branch as your feature work
  • Collaboration: Team members can work on tests using their preferred tools
  • CI/CD integration: Tests in GitHub can be easily integrated into your CI/CD pipeline
  • Backup: Your tests are safely stored in your repository
  • Code review: Tests can go through the same code review process as your application code
  • Shift-left: QAs author and run tests on feature branches against preview URLs

GitHub Sync ensures your SmartTests are always in sync with your codebase and available to your entire team, with the flexibility to work branch-by-branch.