Skip to content

Knowledgebase

Maintaining a deployment log and release identifier

development

A concise release record connects an observed problem to the code, configuration and database changes that reached the server. It reduces guesswork during support and recovery.

What you need before you begin

Choose a protected location for deployment records and a safe way to identify the active release. Do not include secrets or customer data in the identifier.

01 Maintain a deployment log and release identifier

  1. Record the commit, artifact checksum, build time and deployment environment. Include the operator or workflow identity that initiated the change.

  2. List migrations, significant configuration changes and worker restarts as references or safe names rather than full secret values.

  3. Record preparation, activation, verification and any recovery result with timestamps. Distinguish a failed attempt from a successfully active release.

  4. Expose only a non-sensitive release identifier through an authenticated diagnostic or deliberately safe status response when useful.

  5. Retain enough history to match incidents and backups with releases. Remove temporary detailed logs according to the agreed retention policy.

02 Example: distinguish an attempted release from the active one

Keep a protected phase record for each deployment. This abbreviated example uses fictional release names.

UTC time Event Active release
09:00 Prepared candidate release-18; artifact checksum verified. release-17
09:03 Candidate readiness check failed before activation. release-17
09:08 Attempt closed with error reference deploy-test-42. release-17

Do not label the server as release 18 merely because its upload finished. Update the active identifier after the actual switch and record rollback activation as another event. Keep the detailed error in private logs, linked by a safe request or deployment ID.

Confirm the expected result

During a test incident, use the record to identify the active code and its compatible recovery artifact. Confirm the record is updated after a rollback as well as a forward deployment.

Troubleshoot unexpected results

If the displayed version disagrees with the deployment log, investigate stale processes, caches or multiple instances. A manually edited version label can conceal rather than solve that mismatch.

A common question

Should every internal build detail be public?

No. A short release identifier can help support, while infrastructure paths, credentials and internal operational notes should remain in the protected record.

Sources and further reading

Was this answer helpful?

Need a little more help?

Our support team can help you find the next step.

Contact support