grim/local-pipelines

Add a readme

2016-06-29, Gary Kramlich
8af9fcf8e6c5
Parents e921b0627ab8
Children e6e27c0f7f40
Add a readme
  • +23 -0
    README.md
  • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/README.md Wed Jun 29 12:11:59 2016 -0500
    @@ -0,0 +1,23 @@
    +# Local Pipelines
    +
    +Local Pipelines parses your bitbucket-pipelines.yml and runs it locally using
    +Docker.
    +
    +This supports mercurial and git.
    +
    +## Running
    +
    +Packaging doesn't exist yet, but you can clone this repo and run it via
    +
    +```
    +python -m pipelines -f /path/to/project/bitbucket-pipelines.yml
    +```
    +
    +And it'll run through it.
    +
    +## TODO
    +
    +Additional environment variable support and need to investigate pipelines a bit
    +more to make sure everything looks the same.
    +
    +