Skip to content

Add CI smoke test example with GitHub Actions workflow#37

Open
dinalivia wants to merge 1 commit intoscanapi:mainfrom
dinalivia:add-ci-smoke-test-example
Open

Add CI smoke test example with GitHub Actions workflow#37
dinalivia wants to merge 1 commit intoscanapi:mainfrom
dinalivia:add-ci-smoke-test-example

Conversation

@dinalivia
Copy link
Copy Markdown

@dinalivia dinalivia commented Apr 10, 2026

Summary

  • Adds a new ci-smoke-tests/ example showing how to run ScanAPI as a post-deployment smoke test step in GitHub Actions
  • Includes a reusable workflow with workflow_dispatch, workflow_call pattern, and an authenticated API example (commented out)
  • Test spec runs 11 tests against JSONPlaceholder: health check, CRUD endpoints, 404 handling, and request chaining
  • Updates root README with a table listing all examples

Motivation

The existing examples show how to write ScanAPI specs, but none demonstrate a CI integration pattern that teams can copy into their own projects. This fills that gap.

Adds a new example showing how to run ScanAPI as a post-deployment
smoke test step in CI. Includes a reusable GitHub Actions workflow,
a test spec against JSONPlaceholder demonstrating health checks,
endpoint validation, and request chaining, plus documentation for
both local and CI usage.
@dinalivia dinalivia requested a review from a team as a code owner April 10, 2026 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant