README
¶
/internal
This directory holds the majority of the code for a golang application. Packages containing application logic should live in this folder.
The go compiler enforces that packages in /internal can not be imported from other go modules via go get.
When writing library code that is intended to be importable by other go modules, make sure not to place any public facing packages in this directory.
There is not a definitive standard for organizining public facing packages. One convention is to place them in their directories in the repo root.
Another is to place each publically importable package in it's own directory under /pkg. Reccomend using the later pattern in order to reduce clutter
in the repo root.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package builds contains the definitions for a control plan for sherlock's build management systems.
|
Package builds contains the definitions for a control plan for sherlock's build management systems. |
|
Package db contains a variety of utility functions and test helpers for working with Sherlock's database.
|
Package db contains a variety of utility functions and test helpers for working with Sherlock's database. |
|
Package environments defines data structure representing a environment instance and methods for interacting with them it is left to concrete implementations in package db or others to implement these interfaces
|
Package environments defines data structure representing a environment instance and methods for interacting with them it is left to concrete implementations in package db or others to implement these interfaces |
|
Package services defines the control plane for sherlock's service entities and api routes for interating with those control plane methods
|
Package services defines the control plane for sherlock's service entities and api routes for interating with those control plane methods |
Click to show internal directories.
Click to hide internal directories.