Development

Faktory's main target is 64-bit Linux. If you have a Go development environment set up, it will be quick and easy to get started.

Linux

1. Clone this repo locally: git clone https://github.com/contribsys/faktory
2. Install Go and Redis, the latest versions should work. Redis must be in your PATH.
3. Run make prepare to download other Go dependencies
4. Run make lint test to verify code and test suite
5. Run make build to compile a binary for your current platform
6. Run make package to build RPM/DEB files

OSX

To build a local Faktory binary on OSX, these are the basic steps:

1. Clone this repo locally: git clone https://github.com/contribsys/faktory
2. Install Redis brew install redis
3. Install Go brew install go
4. Run make prepare to download other Go dependencies
5. Run make test to verify code and test suite
6. Run make build to compile binaries

Cutting a new Release

(this is documented so @mperham follows the exact release process everytime)

• Ensure versions (Makefiles and client/faktory.go) and changelogs {Ent-,Pro-,}Changes.md are up-to-date.
• Ensure make lint test passes. Start Docker.
• Ensure OSS and commercial repos are committed and pushed.
• within ent: make prerel
• within ent: make ossrel
• within ent: make release
• within homebrew-faktory, make VER=$VERSION, e.g. VER=1.5.4 and commit
• bump versions, commit