tantalic/verify-deployment-manifest

Deployment Manifest

A simple method to query information about the deployed version of a site or application. This is accomplished by providing a JSON deployment manifest that includes the version control system (typically git) commit id and reference (branch or tag) from which an application/site was built. (We also recommend including additional fields which may be useful for inspection by additional tools and by humans.)

Why?

This was developed with two primary use-cases in mind:

• As part of post-deployment tests within a CI/CD pipeline to verify the desired version of an application has been successfully deployed.
• Provide the ability to easily and quickly inspect (manually or through tools) the currently deployed version of an application in any environment.

Deployment Manifest Specification

{
    "commit": "052b2762382f956c378c99aa626ca8faf3d76562",
    "ref": "1.1.3",
    "date": "Tue May 9 22:01:14 GMT 2017",
    "pipelineId": "764"
}

Tools

This repository includes the following tools for working with deployment manifests:

• verify-deployment-manifest - Validate that the expected commit/ ref is deployed to an environment by checking a deployment manifest for expected versions.

• deployment-badge-server - Show SVG badge with deployment information, suitable for including in a README or wiki page.