Back to Reference Index

pipe deploy

Usage

pipe deploy PIPELINE_NAME

Description

Deploy pipeline.

Examples:

pipe deploy
pipe deploy demo # explicitly specify pipeline name
pipe deploy demo -b mybranch # specify git branch

The pipeline is generated from the DSL and created with CloudFormation. The files that the DSL evaluates are in the .pipedream folder:

.pipedream/pipeline.rb
.pipedream/role.rb
.pipedream/schedule.rb
.pipedream/webhook.rb

To create the CodePipeline pipeline, you run:

pipe deploy

You’ll see output that looks something like this:

$ pipe deploy
Generated CloudFormation template at /tmp/codepipeline.yml
Deploying stack demo-pipe with CodePipeline project demo
Creating stack demo-pipe. Check CloudFormation console for status.
Stack name demo-pipe status CREATE_IN_PROGRESS
Here's the CloudFormation url to check for more details https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks
Waiting for stack to complete
04:14:03AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack demo-pipe User Initiated
04:14:06AM CREATE_IN_PROGRESS AWS::IAM::Role IamRole
04:14:07AM CREATE_IN_PROGRESS AWS::IAM::Role IamRole Resource creation Initiated
04:14:25AM CREATE_COMPLETE AWS::IAM::Role IamRole
04:14:28AM CREATE_IN_PROGRESS AWS::CodePipeline::Pipeline Pipeline
04:14:29AM CREATE_IN_PROGRESS AWS::CodePipeline::Pipeline Pipeline Resource creation Initiated
04:14:29AM CREATE_COMPLETE AWS::CodePipeline::Pipeline Pipeline
04:14:31AM CREATE_IN_PROGRESS AWS::CodePipeline::Webhook Webhook
04:14:33AM CREATE_IN_PROGRESS AWS::CodePipeline::Webhook Webhook Resource creation Initiated
04:14:33AM CREATE_COMPLETE AWS::CodePipeline::Webhook Webhook
04:14:35AM CREATE_COMPLETE AWS::CloudFormation::Stack demo-pipe
Stack success status: CREATE_COMPLETE
Time took for stack deployment: 35s.
$

Explicit Pipeline Name

By default, the pipeline name is inferred and is the parent folder that you are within. You can explicitly specify the pipeline name as the first CLI argument:

pipe deploy my-pipeline

Specify Git Branch

It is useful to build pipelines with different source git branches. You can pass a --branch option to the pipe deploy command. The cli —-branch option always takes the highest precedence. Example:

pipe deploy my-pipeline --branch my-branch

Note: When you specify a branch pipedream actually first updates the pipeline before starting the pipeline execution. This is done because CodePipeline does not natively support specifying the branch. It is discussed more here: Using Different Branches.

Options

b, [--branch=BRANCH]             # git branch
    [--stack-name=STACK_NAME]    # Override the generated stack name. If you use this you must always specify it
    [--wait], [--no-wait]        # Wait for operation to complete
                                 # Default: true
    [--verbose], [--no-verbose]  
    [--noop], [--no-noop]

Edit this page

See a typo or an error? You can improve this page. This website is available on GitHub, and contributions are encouraged and welcomed. We love pull requests from you!