Skip to content
RecipesDoc

Smoke Suite on Every GitHub Pull Request, as a Check and a Comment

The Certyn GitHub App runs your smoke test cases on each pull request and posts the result as a check and a PR comment.

For teams on GitHub who want a smoke check on every pull request without writing workflow YAML.

Your setup

  • The app's code is in a GitHub repo.
  • Certyn test cases for your critical paths, or none yet.
  • A test environment, for example staging, that the smoke tests run against.

Say this to Certyn

Run our smoke tests on every pull request to main in acme/web, and post the result on the PR.

What Certyn does

  1. Opens the GitHub connect form for pipelines: install the Certyn GitHub App and pick the repo.
  2. Lists your test cases tagged smoke. If there are none, it proposes a few for your critical paths (sign in, search, checkout) and tags them smoke after you agree.
  3. Creates a Certyn suite process for the smoke tag (app.process.create, type certyn).
  4. Sets the pull request rule (app.citrigger.set): that suite, your environment, target branch main, PR comment on. You approve the change.

What you get

  • A Certyn check on each pull request commit: failed when a smoke test fails, action required when a test is blocked.
  • One PR comment with the result, updated in place on each new commit.
  • A run report, and a Certyn issue with evidence for each real product bug.
  • To block merges on it, make the Certyn check required in your branch protection.

Limits

  • The suite runs against the Certyn environment in the rule, not against the PR's own build. To test the PR's own deploy, see Preview URL per Pull Request.
  • GitHub App rules run Certyn suites only. To run your own repo tests or a goal on each PR, use GitHub Actions with certyn-one/action@v1.
  • A new commit on the PR cancels the run still going for the old one.
  • GitHub only. For GitLab, see Gate a GitLab Deploy on Certyn.