Skip to content

Release Checklist

This page lists the items that must be completed before every release.

Pre-release checks

  • Confirm testing is complete

  • All planned test items are finished and verified.

  • No critical/regression issues remain open.

  • Review documentation impact

  • Validate whether the release requires documentation updates.

  • Ensure any required docs are updated and reviewed.

  • Prepare release notes

  • Collect and summarize the changes included in the release.

  • Highlight breaking changes, migrations, and customer-facing impact.

  • Update internal documentation

  • Document environment variable changes

    • List all added / removed / renamed environment variables.
    • Provide default values, required/optional status, and examples.
    • Note any required secrets and where they are stored.

    • Document image changes

    • List changed image names/tags/digests.

    • Note base image changes (OS/runtime), entrypoint changes, and CA/certificate requirements.
    • Record rollback guidance (previous known-good tags).

    • Document installation / runtime impact

    • Docker: compose changes, volume migrations, permission changes, required flags.

    • Podman: compatibility notes vs Docker (rootless, networking, volume/SELinux labels).
    • Kubernetes: chart value changes, new/removed templates, upgrade steps.
    • OpenShift: SCC/permissions, Route/Ingress changes, and platform-specific requirements.

    • Document deployment mode impact

    • DMZ mode: A deployment mode that uses network segmentation. In this mode, public-facing web servers are deployed in the DMZ zone. Backend services are deployed in the internal LAN and communicate according to predefined ingress/egress rules.

    • Single-Zone mode: A deployment mode where public-facing web servers and backend services are deployed within the same zone (no DMZ segmentation).
    • Ensure operational/runbook steps are updated and reviewed by relevant owners.

Post-release verification

  • Run smoke tests after release

  • Execute the agreed smoke test suite.

  • Validate key user journeys and critical services.
  • Record results and link to evidence (logs, dashboards, test reports).
  • Release checklist details: (link to the detailed checklist page, if any)
  • Test plan / QA board: (link)
  • Release notes draft: (link)
  • Smoke test report: (link)