Why it matters
Use this workflow to identify applicable template risks before deployment, generate architecture context, and carry evidence into GitHub or CLI review. Unsupported or unavailable evaluation areas must remainNot assessed rather than appearing to pass.
Quick example
Start with the public AWS CloudFormation review example.Demo pull requests
The example repository keeps long-lived PRs open so you can inspect the review output before wiring your own repository:
The Action runs only after the repository has a Cloudeval GitHub project and the
CLOUDEVAL_ACCESS_KEY and CLOUDEVAL_PROJECT_ID secrets are configured. Without those secrets, the example workflow exits early so forks are safe.
Supported workflow
1
Choose a supported template source
Use CloudFormation JSON or YAML from a local workspace or GitHub-linked project.
2
Confirm the project boundary
For repositories with multiple or nested templates, commit
.cloudeval/config.yaml and identify the intended roots and entry templates.3
Run the review
Use the CLI locally or the GitHub Action in CI. Keep the ref, commit, and source root with the review artifact.
4
Inspect applicability
Review findings, evidence, unsupported resources, and every
Not assessed area before making a merge decision.Coverage boundary
Related pages
- Supported clouds and IaC formats
- Evaluation coverage
- IaC project configuration
- Review with GitHub Actions
- Review CloudFormation before deployment: tools compared — compare linting, policy checks, PR review and change sets.