Tools for AWS CodePipeline.
Project description
codepiper
This tool provides some utilities for working with AWS CodePipeline:
watch
- Monitor a pipeline for executions and also follow CodeBuild logs.debug
- Run stage with debug mode enabled.verify_clear
- Verify that a pipeline is clear, or the details if not.rollback
- Rollback a stage of a pipeline to a prior execution.
Watch
To monitor all active executions for a pipeline:
codepiper --profile toolchain --region us-west-2 watch -p my-pipeline-name
To monitor a pipeline along with logs from CodeBuild:
codepiper --profile toolchain --region us-west-2 watch -p my-pipeline-name -f
To monitor one specific execution for a pipeline:
codepiper --profile toolchain --region us-west-2 watch -p my-pipeline-name -e 20b20f00-f63d-4b05-8921-20a4fc16090e
codepiper --profile toolchain --region us-west-2 verify_clear -p my-pipeline-name
Debug
View a running build in Session Manager
You will need to add the codebuild-breakpoint
command in the buildspec where you want to pause execution. When you are done debugging run codebuild-resume
in the CLI to resume the build.
The debug option will output a codebuild URL for the build. Once the build is PROVISIONED there will be an SSM Session link to follow to get CLI access.
To run a pipeline stage in debug mode:
codepiper --profile toolchain --region us-west-2 debug --pipeline my-pipeline-name --stage Integration
To run a pipeline stage in debug mode with new or overridden env vars:
codepiper --profile toolchain --region us-west-2 debug --pipeline my-pipeline-name --stage Integration --envvar JAVA_OPTS="-Xmx1g -Dproperty=value" --envvar JAVA_VAR1=new_value
Rollback
To rollback a pipeline stage to last successful execution:
codepiper --profile toolchain --region us-west-2 rollback -p my-pipeline-name -s Production
To rollback a pipeline stage to a specific commit id:
codepiper --profile toolchain --region us-west-2 rollback -p my-pipeline-name -s Production -c af32c18
To rollback a pipeline stage and watch logs
codepiper --profile toolchain --region us-west-2 rollback -p my-pipeline-name -s Production -f
Verify Pipeline Clear
To verify that a pipeline is currently clear:
codepiper --profile toolchain --region us-west-2 verify_clear --pipeline my-pipeline-name
Installation
Use the upgrade
flag to ensure you have the latest version.
pip install codepiper --upgrade
Limitations
$CODEBUILD_RESOLVED_SOURCE_VERSION
is unavailable since the CodeBuild execution is not initiated via CodePipeline. The workaround for this is to use CodePipeline Variables to pass theCommitId
from source stage as a user defined environment variable to your CodeBuild project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for codepiper-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa5ee198e634e54218d075e2e2e439ee96c0c0f96144aa16b8b08966cca44fc0 |
|
MD5 | e3748dedcb6a7bcf46e7cb94047dd070 |
|
BLAKE2b-256 | 1e0fc16fab2f16d084bc0d6c11f990d9b41a5e857c539143457adc313e5be187 |