The Wercker CLI can be used to execute pipelines locally for both local development and easy introspection.
Go Shell Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Documentation Wrkr 501 (#463) Aug 1, 2018
api Use auth token when interacting w/ step registry for private steps. (#… Jul 3, 2018
auth Default docker hub push to registry V2 (#348) Nov 28, 2017
cmd Wrap errors in runner (#487) Aug 16, 2018
core add support for OCI object storage (#465) Aug 14, 2018
docker add support for OCI object storage (#465) Aug 14, 2018
event Revert to 1205 nodockernetwork (#397) Apr 25, 2018
external Remove journal logging (#455) Jul 26, 2018
rdd Wrkr-592 - Deprovision RDD for builds aborted/interrupted (#461) Aug 1, 2018
rddpb Wrkr 389 - Changes for Accessing RDD API and injecting RDD url in pip… Jun 14, 2018
scripts Change deployment to pipelines (#197) Jul 1, 2016
steps Support for publishing private steps (#409) May 14, 2018
tests Run pipeline in remote docker daemon (#442) Jul 20, 2018
util Run pipeline in remote docker daemon (#442) Jul 20, 2018
vendor Revert2 (#486) Aug 15, 2018
.gitignore Remove journal logging (#455) Jul 26, 2018
CONTRIBUTING.md Add details about how to contribute to this repository (#400) Apr 27, 2018
LICENSE adds LICENSE Jan 28, 2016
README.md Revert2 (#486) Aug 15, 2018
changelog.md Update changelog (#488) Aug 16, 2018
main.go Wercker CLI changes for external runner (#406) May 8, 2018
rdd.proto Wrkr 389 - Changes for Accessing RDD API and injecting RDD url in pip… Jun 14, 2018
test-all.sh Run pipeline in remote docker daemon (#442) Jul 20, 2018
triage.yml update the triage project Feb 9, 2016
wercker.yml Revert2 (#486) Aug 15, 2018

README.md

wercker - your new favorite dev tool

wercker status

This is the project for wercker, the command-line tool that powers all the build and deploy jobs for wercker.com, it runs on your local machine with the help of Docker.

Wercker is designed to increase developer velocity by enabling users to run and automate their tests and builds, leveraging Docker containers to provide development environments for multi-service architectures.

Note: While the Wercker team has extensive experience with open source, this project has been internal for some time and may have some rough edges. We'll be actively prettying up the codebase and the project, but we wanted to release it to you as early as possible.

The master branch may be in a broken or unstable state during development. It is recommended that you download wercker through the CLI section on our website, if you're not contributing to the code base.

Building wercker

wercker is built using Go version 1.5 or greater. If you don't have it already, you can get it from the official download page. Once you go installed, set up your go environment by using this guide

Next, you'll need govendor to install the golang dependencies. You can do this by running:

  go get github.com/kardianos/govendor

In Go 1.5 you'll need the vendor experiment enabled, so make sure to export GO15VENDOREXPERIMENT=1 in your shell (see Go 1.5 Vendor Experiment)

In your git checkout ($GOPATH/src/github.com/wercker/wercker), run:

   govendor sync

This command should download the appropiate dependencies.

Once all that is setup, you should be able to run go build and get a working executable named wercker.

Once you've got a working Docker environment, running

  ./wercker build

should go through the entire build and testing process.

Note: this is the bare minimum to build and contribute to the code base. If you do not have a local Docker environment you will not be able to run and test wercker properly. You can follow this guide to install Docker on your machine.

Reporting Bugs

If you are experiencing bugs running wercker locally, please create an issue containing the following:

  • Which OS are you using?
  • Which Docker environment are you using? (Boot2docker, custom, etc)
  • Create a gist containing the following information:
    • The entire log when running wercker with the --debug log. (ie. wercker --debug build)
    • The wercker.yml file that causes the issues.

Please don't file any issue dealing with the usage of steps or unexpected behavior on hosted wercker.

If you are experiencing issues running builds or deploys on hosted wercker, please do the following:

Try running the build again to see if the error keeps occurring. If it does, turn on support for the application, and create an issue with the following information:

  • The application owner and application name.
  • The ID of the build or deploy that failed.

Contributing to this repository

Oracle welcomes contributions to this repository from anyone. Please see CONTRIBUTING for details.

Contact

Join us in our slack room: Slack Status

License

wercker is under the Apache 2.0 license. See the LICENSE file for details.