https://github.com/liemle3893/golang-monorepo-example
https://github.com/liemle3893/golang-monorepo-example
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/liemle3893/golang-monorepo-example
- Owner: liemle3893
- License: mit
- Created: 2020-08-28T19:23:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-28T19:43:19.000Z (almost 5 years ago)
- Last Synced: 2025-01-08T11:41:32.785Z (5 months ago)
- Language: Shell
- Size: 124 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/liemle3893/golang-monorepo)
## Overview
This is an example of a golang-based monorepo. It has the following features:
- Only build the services or cmds that are modified in a commit;
- Build all services and/or cmds that are affected by changes in common codes (i.e. `pkg`);
- Build all services and/or cmds that are affected by changes in `vendor` codes.
At the moment, CI is setup to use Go 1.14[.x] with `GO111MODULE=on` and `GOFLAGS=-mod=vendor` environment variables enabled during build. See sample [dockerfile](./services/samplesvc/dockerfile.samplesvc) for more details.
## How does it work
When the changes belong to either `pkg` or `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.
## Directory structure
- `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](./services/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](./services/samplesvc) contents to your new directory.
- Update the dockerfile inside your new service directory. Note that during build, this dockerfile is [copied](https://github.com/liemle3893/golang-monorepo/blob/master/services/samplesvc/Makefile#L21) to the root directory (to be able to access `pkg` and `vendor` directories).
- Update the [Makefile](./services/samplesvc/Makefile) with your own values. You need to at least update the `MODULE` variable with your service name. The only required rule is the `custom` part so you may need to change that as well (i.e. name of the dockerfile used in `docker build`).
- [Optional] Update the [deploy.sh](./services/samplesvc/deploy.sh) script for your deployment needs.
## Need help
PR's are welcome!
- [ ] Support for other CI, i.e. GitHub Workflow
- [ ] Make it work without the `vendor` folder as well
## Misc
https://tech.mobingi.com/2018/09/25/ouchan-monorepo.html
## Inprised by: https://github.com/flowerinthenight/golang-monorepo