Skip to content

improvements: restructure go modules #229

@Anmol1696

Description

@Anmol1696

Overview

Currently the structure is flat which ends up looking like:

starship/
	cmd/
	  starship/
	registry/
  faucet/
  exposer/
  client/
  tools/
  ...

The benifit of this structure is:

  • Seperate go.mod for each of the components
  • Each component has its own build system as well as Dockerfile

Proposal

We should restructure the go modules such that they become part of the same go.mod as well. Something like:

starship/
  cmd/
    cli/
    registry/
    faucet/
    exposer/
pkg/
  registry/
  faucet/
  exposer/
  client/
  tools/
go.mod

Pros:

  • Cleaner structure in the root dir
  • Single go.mod will be needed (can have seperate ones too)
  • Can couple config logging together as well into one system.

Cons:

  • Different versions release wont be easy to do next (currently we dont have differnt versions anyways)
  • All the pkgs will be around being http handlers and a microservice instead of packages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions