Skip to content

Repository files navigation

Deployment Verifier

Configuration-driven post-deployment verification for websites and APIs. Poll readiness, confirm the expected build reached the target, and execute critical smoke checks before declaring a deployment successful.

Release status: Initial public alpha. Verification should complement—not replace—platform health checks, observability, and a tested rollback process.

Features

  • Readiness polling with bounded attempts and intervals
  • Build identity from an HTTP header, JSON path, or response body
  • Critical GET and HEAD route checks
  • Status and response-time expectations
  • Body inclusion and exclusion assertions
  • Header presence and exact-value assertions
  • Nested JSON-path existence and value assertions
  • Request retries and timeouts
  • JSON and Markdown reports with GitHub job summaries
  • Containerized GitHub Action

Install and run

Requires Node.js 22.19 or newer.

npm install
npm run verify -- --config config.example.yaml --expected-build "$GIT_SHA"

Validate without making requests:

npm run verify -- --config config.example.yaml --validate

Reports are written to reports/deployment-verification.json and reports/deployment-verification.md. Failed verification returns exit code 1; configuration and execution errors return exit code 2.

Build identity

Applications should expose an immutable deployment identifier such as a Git commit SHA or image digest through a version endpoint or response header.

build_identity:
  path: /version.json
  source: json
  key: build

Pass the expected identifier with --expected-build or EXPECTED_BUILD_ID.

Assertions

Supported types are body_contains, body_not_contains, header_present, header_equals, json_path_exists, and json_path_equals. See config.example.yaml and schema/config.schema.json.

Project boundary

This repository is a generic verification engine. It contains no private URLs, credentials, client data, production topology, notification routing, or automatic rollback integration.

License

MIT © 2026 CodeVelo.dev LLC.

About

Verify deployment readiness, response assertions, and expected build identity.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages