CLI Reference¶
The Handel-CodePipeline command-line interface should be run in a directory with a handel-codepipeline.yml file.
It defines four commands: check, deploy, delete and list-required-secrets
handel-codepipeline check¶
Validates that a given Handel-CodePipeline configuration is valid.
Parameters¶
handel-codepipeline check does not accept parameters.
handel-codepipieline deploy¶
Validates and deploys the resources in a given environment.
Parameters¶
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
–pipeline <value> | string | Yes | The pipeline from your handel-codepipeline.yml file that you wish to deploy. | |
–account_name <value> | string | Yes | The account you are deploying into. | |
–secrets <value> | Secrets | yes | The base64 encoded JSON string of the deploy secrets. See Secrets |
Secrets¶
A base64 encoded array of secrets objects. Note that the required secrets can be obtained with handel-codepipeline list-required-secrets.
[
{
"phaseName": "Github", // The phase the secret is associated with.
"name": "githubAccessToken", // The name of the secret
"message": "'Github' phase - Please enter your GitHub access token", // This is not necessary, but will be present if the original object was obtained from handel-codepipeline list-required-secrets.
"value": "ABCDEFGHIJKLMNOPQRSTUVWXYZ" // The secret's value
}
]
handel-codepipeline delete¶
Deletes the AWS CodePipeline.
Parameters¶
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
–pipeline <value> | string | Yes | The pipeline from your handel-codepipeline.yml file that you wish to delete. | |
–account_name <value> | string | Yes | The account you are deploying into. |
handel-codepipeline list-required-secrets¶
Returns a JSON string with all of the secrets required for the pipeline.
Parameters¶
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
–pipeline <value> | string | Yes | The pipeline from your handel-codepipeline.yml file that you want to retreive required secrets from. |
Example Response¶
[
{
"phaseName": "Github",
"name": "githubAccessToken",
"message": "'Github' phase - Please enter your GitHub access token"
},
{
"phaseName": "npmDeploy",
"name": "npmToken",
"message": "npmDeploy' phase - Please enter your NPM Token"
},
{
"phaseName": "pypiDeploy",
"name": "pypiUsername",
"message": "'pypiDeploy' phase - Please enter your PyPi username"
},
{
"phaseName": "pypiDeploy",
"name": "pypiPassword",
"message": "'pypiDeploy' phase - Please enter your PyPi password"
},
{
"phaseName": "RunscopeTests",
"name": "runscopeTriggerUrl",
"message": "'RunscopeTests' phase - Please enter your Runscope Trigger URL"
},
{
"phaseName": "RunscopeTests",
"name": "runscopeAccessToken",
"message": "'RunscopeTests' phase - Please enter your Runscope Access Token"
},
{
"phaseName": "Notify",
"name": "slackUrl",
"message": "'Notify' phase - Please enter the URL for Slack Notifications"
}
]