This is an example of a golang-based monorepo. It has the following features:
- Only build the services or cmds that are updated.
- Build all services and/or cmds that are affected by changes in common codes (i.e.
- Build all services and/or cmds that are affected by changes in
It uses dep as its dependency management tool.
How does it work
During CircleCI builds, the script iterates the updated files within the commit range (
CIRCLE_COMPARE_URL environment variable in CircleCI) or the changed files within a single commit (when the value is not a valid range), excluding hidden files,
vendor folders. It will then try to walk up the directory path until it can find a Makefile (excluding root Makefile). Once found, the root Makefile will include that Makefile and call the
custom rule as target, thus, initiating the build.
When the changes belong to either
vendor, the script will then try to determine the services (and cmds) that have dependencies using the
go list command. All dependent services will then be built using the same process described above.
services/- Basically, long running services.
cmd/- CLI-based tools that are not long running.
pkg/- Shared codes, or libraries common across the repo.
vendor/- Third party codes from different vendors.
Although we have this structure, there is no limitation into where should you put your services/cmds. Any subdirectory structure is fine as long as a Makefile is provided.
How to add a service/cmd
A reference template named samplesvc is provided. Basically, these are the things that you need to do:
- Create a new directory for your service under
services/or tool under
cmd/. You may copy the samplesvc contents to your new directory.
- Provide a dockerfile in the root directory. You may copy the sample file dockerfile.samplesvc and update it accordingly.
- If your dockerfile doesn't need items from root (i.e. you don't need to copy
vendor), you can put it in your service's directory. Just remember that your Makefile will be called from the root directory during CI builds.
- Update the Makefile with your own values. You need to at least update the
MODULEvariable with your service name. The only required rule is the
custompart so you may need to change that as well (i.e. name of the dockerfile used in
- [Optional] Update the deploy.sh script for your deployment needs.