https://github.com/boltops-tools/pipedream

Beautiful and Powerful DSL Tool to Easily Create AWS CodePipeline Pipelines Quickly
https://github.com/boltops-tools/pipedream

aws codepipeline ruby

Last synced: about 2 months ago
JSON representation

Beautiful and Powerful DSL Tool to Easily Create AWS CodePipeline Pipelines Quickly

• Host: GitHub
• URL: https://github.com/boltops-tools/pipedream
• Owner: boltops-tools
• License: mit
• Created: 2019-06-18T16:27:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-10T12:12:26.000Z (9 months ago)
• Last Synced: 2024-05-01T11:29:03.485Z (5 months ago)
• Topics: aws, codepipeline, ruby
• Language: Ruby
• Homepage: https://pipedream.run
• Size: 1.6 MB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Support: docs/support.md

Awesome Lists containing this project

README

        


  



# Pipe Dream

![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiWk1FM0dldzE5MUM5R3VqVGxxTmRFb1JGNnkxQjJpTDYvajYrQk91YzErNjdNc1VYVElHM3V5ZEJXcStyMmZVc210WG8vUURSV2JST0ZpSWc5Y0pYR3k0PSIsIml2UGFyYW1ldGVyU3BlYyI6IldvYXhLMU8yS2pQdVRKbEoiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

[![Gem Version](https://badge.fury.io/rb/pipedream.png)](http://badge.fury.io/rb/pipedream)

[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)

Pipe Dream provides a DSL to make it easy create a CodePipeline pipeline.

Pipe Dream installs `pipedream` and `pipe` executables. Both of them do the same thing, `pipe` is just shorter to type.

The documentation site is at: [pipedream.run](https://pipedream.run/)

## Quick Start

    pipe init

    pipe deploy

    pipe start

    pipe delete

## Init and Structure

First, run `pipe init` to generate a starter `.pipedream` folder structure.

    $ tree .pipedream

    .pipedream

    ├── pipeline.rb

    └── schedule.rb

File | Description

--- | ---

pipeline.rb | The CodePipeline pipeline written as a DSL.  This is required. Here are the [Pipeline DSL docs](https://pipedream.run/docs/dsl/pipeline/)

schedule.rb | A CloudWatch scheduled event written as a DSL. Here are the [Schedule DSL docs](https://pipedream.run/docs/dsl/schedule/)

## DSL

.pipedream/pipeline.rb:

```ruby

stage "Source" do

  github(

    source: "tongueroo/demo-ufo",

    auth_token: ssm("/github/user/token")

  )

end

stage "DeployStacks" do

  codebuild "demo1"           # action declaration

  codebuild "demo2", "demo3"  # will run in parallel

  codebuild "demo4"           # action declaration

end

```

More [DSL docs](https://pipedream.run/docs/dsl/)

## Installation

Add this line to your application's Gemfile:

    gem "pipedream"

And then execute:

    bundle

Or install it yourself as:

    gem install pipedream

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am "Add some feature"`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request