CI/CD & Release
Release Checklist for Developers
Ship safer releases with version notes, migrations, monitoring, smoke tests and support handoff. This Formalint reference is designed for developers, DBAs, platform engineers and support teams who need an ordered troubleshooting path.
The page keeps the work practical: collect evidence, avoid leaking secrets, make the smallest safe change and leave a note another engineer can repeat.
When to use it
- A deployment, policy, incident or integration behaves differently than expected.
- You need a repeatable command or checklist before changing production behavior.
- You want to keep the debugging note understandable for another engineer.
Practical workflow
| Step | What to verify |
|---|---|
| Read the failing run | Capture job name, runner, commit SHA, environment, cache state and exact failing command. |
| Compare with local | Prove whether the same command fails locally, in CI, in preview or only in production. |
| Release with rollback | Keep rollback owner, smoke test result and monitoring link next to the deployment note. |
Command or evidence sample
version
migration
feature flags
smoke tests
monitoring
support note
rollback ownerReview checklist
- Write down the affected host, endpoint, job, service or browser context.
- Redact tokens, session cookies, passwords and customer identifiers.
- Capture timestamps, headers, logs or command output before changing settings.
- Prefer staged rollout, report-only mode, preview checks or single-URL cache purges where possible.
- Link the final note to a related Formalint page so the next step is obvious.
Common mistake
The common mistake is rerunning CI until it passes without preserving the command, runner and environment evidence.
Formalint's rule for these areas is simple: make the hidden system boundary visible before you tune it.
Related Formalint references
Continue with Git Rebase Workflow Guide, Docker Compose Debugging Guide, Api Debugging Checklist.
Frequently asked questions
Is this page enough for production approval?
No. Use it as a diagnostic and review aid, then follow your team's release, security and compliance process.
Can I paste real secrets or logs here?
No. Keep secrets and customer data out of browser tools. Use redacted examples and preserve sensitive evidence only in approved internal systems.