core

README

CodeComet core go library

Provides basics to be used by all our go projects, specifically:

• logging (based on zerolog)
• reporter (based on Sentry)
• telemetry (based on otel)
• network (to ease manipulation of global network settings, specifically related to TLS)
• exec (to ease shelling out)

Dev

Makefile

• make lint
• make lint-fix
• make tidy

Local documentation

Install pkgsite: go install golang.org/x/pkgsite/cmd/pkgsite@latest

Run it: pkgsite

Open: http://localhost:8080/github.com/go.codecomet.dev/core

Charter

1. This should contain solely stuff that is generic, likely to be used by any reasonnable go project (eg: logging, telemetry, etc). Refrain from adding here anything that is specific to a given project, or ecosystem.

2. Hide implementation away. Specifically, make sure the underlying dependencies do not leak into your API.