Development - contribsys/faktory GitHub Wiki
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.
- Clone this repo locally:
git clone https://github.com/contribsys/faktory
- Install Go and Redis, the latest versions should work. Redis must be in your PATH.
- Run
make prepare
to download other Go dependencies - Run
make lint test
to verify code and test suite - Run
make build
to compile a binary for your current platform - Run
make package
to build RPM/DEB files
To build a local Faktory binary on OSX, these are the basic steps:
- Clone this repo locally:
git clone https://github.com/contribsys/faktory
- Install Redis
brew install redis
- Install Go
brew install go
- Run
make prepare
to download other Go dependencies - Run
make test
to verify code and test suite - Run
make build
to compile binaries
(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.
- Update OSS link in Enterprise with
go get -u github.com/contribsys/faktory@<latestSHA>
. Test. - Ensure
make lint test
passes. Start Docker. - Ensure OSS and commercial repos are committed and pushed.
- within ent:
make prerel
- Update OSS link in Enterprise with
go get -u github.com/contribsys/faktory@<version>
. - 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