Star on GitHubGitHub Actions
Run DevTools YAML flows in GitHub Actions and publish JUnit results for PR checks. Great for smoke and regression suites that run on pushes and pull requests.
For the full setup (PR checks, artifacts, caching, smoke vs regression), see the API regression testing guide.
Required env vars
Depends on your flows. Common examples:
LOGIN_EMAIL,LOGIN_PASSWORD- API keys or base URLs (set via repository/environment secrets)
How to run it
Create .github/workflows/api-tests.yml:
name: API tests
on: [push]Commit and push to trigger the workflow.
TODO:
- Add a screenshot of PR checks showing JUnit summary.
- Short clip of the workflow logs highlighting
devtoolsoutput.
name: API tests
on: [push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install DevTools CLI
run: curl -fsSL https://sh.dev.tools/install.sh | bash
- name: Run flows (JUnit)
run: devtools flow run --report junit:test-results.xml tests.yamlWhat to change
- Path to your YAML flows file (
tests.yaml). - Triggers (
on), job names, and matrix strategy. - Additional reports: JSON and console alongside JUnit.
Common variations
- Artifact upload of JUnit/JSON reports.
- Matrix per service or environment.
- Scheduled nightly runs with
cron. - Fail-fast or continue-on-error for flaky suites.