Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.09 KB

deployment-payload.md

File metadata and controls

19 lines (15 loc) · 1.09 KB

Deployment Payloads

The deployment payload is a JSON data structure that gets uploaded to GitHub when a new deployment is created. The values in this payload can be almost anything you want. The branch-deploy GitHub Action hydrates the deployment payload with some useful information that can be accessed later on in the deployment process if you need it.

Here is the data that the branch-deploy Action will add to the deployment payload:

{
    "params": "<string>",
    "parsed_params": "<object>",
    "sha": "<string>",
    "type": "branch-deploy"
}
  • params - This is the raw string of parameters that were passed to the branch-deploy Action. You can read more about parameters here.
  • parsed_params - This is the parsed version of the params string. This is a JSON object that is created by parsing the params string. You can read more about parameters here.
  • sha - This is the commit SHA that is being deployed.
  • type - This is the type of deployment that is being created. This will always be branch-deploy for the branch-deploy Action.