Skip to content

A continuation of HomeBox the inventory and organization system built for the Home User

feat: set version flag (#632)

Haydend6b0062ae93b
diff --git a/backend/app/api/main.go b/backend/app/api/main.go
index 19258b0f..5da695b8 100644
--- a/backend/app/api/main.go
+++ b/backend/app/api/main.go
@@ -35,6 +35,15 @@ var (
buildTime = "now"
)
+func build() string {
+ short := commit
+ if len(short) > 7 {
+ short = short[:7]
+ }
+
+ return fmt.Sprintf("%s, commit %s, built at %s", version, short, buildTime)
+}
+
// @title Homebox API
// @version 1.0
// @description Track, Manage, and Organize your Things.
@@ -47,7 +56,7 @@ var (
func main() {
zerolog.ErrorStackMarshaler = pkgerrors.MarshalStack
- cfg, err := config.New()
+ cfg, err := config.New(build(), "Homebox inventory management system")
if err != nil {
panic(err)
}
diff --git a/backend/internal/sys/config/conf.go b/backend/internal/sys/config/conf.go
index 932affe1..28c278da 100644
--- a/backend/internal/sys/config/conf.go
+++ b/backend/internal/sys/config/conf.go
@@ -15,6 +15,7 @@ const (
)
type Config struct {
+ conf.Version
Mode string `yaml:"mode" conf:"default:development"` // development or production
Web WebConfig `yaml:"web"`
Storage Storage `yaml:"storage"`
@@ -46,10 +47,15 @@ type WebConfig struct {
// New parses the CLI/Config file and returns a Config struct. If the file argument is an empty string, the
// file is not read. If the file is not empty, the file is read and the Config struct is returned.
-func New() (*Config, error) {
+func New(buildstr string, description string) (*Config, error) {
var cfg Config
const prefix = "HBOX"
+ cfg.Version = conf.Version{
+ Build: buildstr,
+ Desc: description,
+ }
+
help, err := conf.Parse(prefix, &cfg)
if err != nil {
if errors.Is(err, conf.ErrHelpWanted) {