Contrôle de version automatique de l'application

193

Est-il possible d'incrémenter automatiquement un numéro de version mineure chaque fois qu'une application Go est compilée?

Je voudrais définir un numéro de version dans mon programme, avec une section d'auto-incrémentation:

$ myapp -version
MyApp version 0.5.132

Étant 0,5 le numéro de version que j'ai défini, et 132 une valeur qui s'incrémente automatiquement chaque fois que le binaire est compilé.

Est-ce possible dans Go?

Sebastián Grignoli
la source

Réponses:

338

L'éditeur de liens Go ( lien de l'outil go ) a une option pour définir la valeur d'une variable de chaîne non initialisée:

-X importpath.name=value
  Set the value of the string variable in importpath named name to

valeur. Notez qu'avant Go 1.5, cette option prenait deux arguments distincts. Maintenant, il faut un argument divisé sur le premier signe =.

Dans le cadre de votre processus de construction, vous pouvez définir une variable de chaîne de version à l'aide de this. Vous pouvez le transmettre via l' gooutil en utilisant -ldflags. Par exemple, étant donné le fichier source suivant:

package main

import "fmt"

var xyz string

func main() {
    fmt.Println(xyz)
}

Ensuite:

$ go run -ldflags "-X main.xyz=abc" main.go
abc

Afin de définir main.minversionla date et l'heure de construction lors de la construction:

go build -ldflags "-X main.minversion=`date -u +.%Y%m%d.%H%M%S`" service.go

Si vous compilez sans initialiser main.minversionde cette manière, il contiendra la chaîne vide.

axw
la source
4
Cette valeur sera-t-elle enregistrée dans le binaire si j'utilise à la go bouildplace de go run?
Sebastián Grignoli
6
go build -ldflags "-X main.minversion `date -u +.%Y%m%d%.H%M%S`" service.go
Sebastián Grignoli
4
goxc le fait pour vous :) par défaut, il compile avec -ldflags "-Xmain.VERSION xxx -Xmain.BUILD_DATE CurrentDateInISO8601", mais vous pouvez configurer ces noms de variables si vous le souhaitez. Voir github.com/laher/goxc ... (avertissement: j'ai écrit goxc)
laher
7
exemple de travail avec la nouvelle syntaxe 1.5 pour l'ajout de la variable go build -ldflags "-X 'main.buildtime=$(date -u '+%Y-%m-%d %H:%M:%S')'"
buildtime
26
notez que le nom complet du package est requis. go build -ldflags "-X pkg.version=123"ne fonctionnera pas tant qu'il go build -ldflags "-X path/to/pkg.version=123"fonctionnera comme prévu. J'espère que ça aide.
csyangchen
27

De plus, je voudrais publier un petit exemple d'utilisation de git et d'un makefile:

--- Makefile ----

# This how we want to name the binary output
BINARY=gomake

# These are the values we want to pass for VERSION and BUILD
# git tag 1.0.1
# git commit -am "One more change after the tags"
VERSION=`git describe --tags`
BUILD=`date +%FT%T%z`

# Setup the -ldflags option for go build here, interpolate the variable values
LDFLAGS_f1=-ldflags "-w -s -X main.Version=${VERSION} -X main.Build=${BUILD} -X main.Entry=f1"
LDFLAGS_f2=-ldflags "-w -s -X main.Version=${VERSION} -X main.Build=${BUILD} -X main.Entry=f2"

# Builds the project
build:
    go build ${LDFLAGS_f1} -o ${BINARY}_f1
    go build ${LDFLAGS_f2} -o ${BINARY}_f2

# Installs our project: copies binaries
install:
    go install ${LDFLAGS_f1}

# Cleans our project: deletes binaries
clean:
    if [ -f ${BINARY} ] ; then rm ${BINARY} ; fi

.PHONY: clean install

Le fichier make créera deux exécutables. L'un exécute la fonction un, l'autre prendra la fonction deux comme entrée principale:

package main

import (
        "fmt"
)

var (

        Version string
        Build   string
        Entry   string

        funcs = map[string]func() {
                "f1":functionOne,"f2":functionTwo,
        }

)

func functionOne() {
    fmt.Println("This is function one")
}

func functionTwo() {
    fmt.Println("This is function two")
}

func main() {

        fmt.Println("Version: ", Version)
        fmt.Println("Build Time: ", Build)

    funcs[Entry]()

}

Ensuite, lancez simplement:

make

Tu auras:

mab@h2470988:~/projects/go/gomake/3/gomake$ ls -al
total 2020
drwxrwxr-x 3 mab mab    4096 Sep  7 22:41 .
drwxrwxr-x 3 mab mab    4096 Aug 16 10:00 ..
drwxrwxr-x 8 mab mab    4096 Aug 17 16:40 .git
-rwxrwxr-x 1 mab mab 1023488 Sep  7 22:41 gomake_f1
-rwxrwxr-x 1 mab mab 1023488 Sep  7 22:41 gomake_f2
-rw-rw-r-- 1 mab mab     399 Aug 16 10:21 main.go
-rw-rw-r-- 1 mab mab     810 Sep  7 22:41 Makefile
mab@h2470988:~/projects/go/gomake/3/gomake$ ./gomake_f1
Version:  1.0.1-1-gfb51187
Build Time:  2016-09-07T22:41:38+0200
This is function one
mab@h2470988:~/projects/go/gomake/3/gomake$ ./gomake_f2
Version:  1.0.1-1-gfb51187
Build Time:  2016-09-07T22:41:39+0200
This is function two
Maciej A. Bednarz
la source
5
Ou plus simple: créez simplement deux principaux dans deux répertoires différents. Cette solution semble être sérieusement sur-conçue.
dolmen
26

J'ai eu du mal à utiliser le -ldflagsparamètre lors de la construction de mon projet d'application et de bibliothèque de ligne de commande mixte, alors j'ai fini par utiliser une cible Makefile pour générer un fichier source Go contenant la version de mon application et la date de construction:

BUILD_DATE := `date +%Y-%m-%d\ %H:%M`
VERSIONFILE := cmd/myapp/version.go

gensrc:
    rm -f $(VERSIONFILE)
    @echo "package main" > $(VERSIONFILE)
    @echo "const (" >> $(VERSIONFILE)
    @echo "  VERSION = \"1.0\"" >> $(VERSIONFILE)
    @echo "  BUILD_DATE = \"$(BUILD_DATE)\"" >> $(VERSIONFILE)
    @echo ")" >> $(VERSIONFILE)

Dans ma init()méthode, je fais ceci:

flag.Usage = func() {
    fmt.Fprintf(os.Stderr, "%s version %s\n", os.Args[0], VERSION)
    fmt.Fprintf(os.Stderr, "built %s\n", BUILD_DATE)
    fmt.Fprintln(os.Stderr, "usage:")
    flag.PrintDefaults()
}

Si vous vouliez un numéro de build à augmentation atomique au lieu d'une date de build, cependant, vous auriez probablement besoin de créer un fichier local contenant le dernier numéro de build. Votre Makefile lit le contenu du fichier dans une variable, l'incrémente, l'insère dans le version.gofichier au lieu de la date, et écrit le nouveau numéro de version dans le fichier.

pegli
la source
2
Belle solution. Pourtant, je pense avoir trouvé la raison des problèmes de -ldflags. Si le fichier contenant la variable mise à jour par -X n'est pas touché, alors la compilation ne se déclenche pas et vous avez l'ancienne version dans le binaire. Ma solution était de toucher un petit fichier contenant uniquement la variable en cours de réinitialisation via -ldflags "-X ..."
Wojciech Kaczmarek
20

Utilisez ldflagspour définir des variables dans le mainpackage:

Avec dossier main.go:

package main

import "fmt"

var (
    version string
    build   string
)

func main() {
    fmt.Println("version=", version)
    fmt.Println("build=", build)
}

Puis exécutez:

go run \
  -ldflags "-X main.version=1.0.0 -X main.build=12082019" \ 
  main.go

Construire:

go build -o mybinary \
  -ldflags "-X main.version=1.0.0 -X 'main.build=$(date)'" \ 
  main.go

Utilisez ldflagspour définir une variable dans un non-mainpackage:

Avec dossier config.go:

package config

import "fmt"

var (
    Version string
)

func LogVersion() {
    fmt.Println("version=", Version)
}

Vous aurez également besoin d'un fichier main.go:

package main

import (
    "fmt"
    "github.com/user/repo/config"
}

func main() {
    config.LogVersion()
}

Construisez d'abord votre binaire:

go build -o mybinary main.go 

Trouvez le chemin complet du nom de la variable que vous souhaitez définir:

go tool nm <path_to_binary> | grep Version

Exécutez et compilez à nouveau le binaire mais avec le ldflags:

go run \
  -ldflags "-X github.com/user/repo/config.Version=1.0.0" \
  main.go --version       


go build -o mybinary \
  -ldflags "-X github.com/user/repo/config.Version=1.0.0" \
  main.go     

Inspiré par https://github.com/golang/go/wiki/GcToolchainTricks#including-build-information-in-the-executable


Aussi si vous utilisez, goreleaserlisez ceci https://goreleaser.com/#using-the-main-version :

Par défaut, GoReleaser définit trois ldflags:

main.version: Balise Git actuelle main.commit: Git
commit actuel SHA
main.date: Date selon RFC3339


Si vous voulez voir cela en action: https://github.com/hoto/fuzzy-repo-finder/blob/master/pkg/config/config.go

Andrzej Rehmann
la source
12

pour utiliser multi -ldflags:

$ go build -ldflags "-X name1=value1 -X name2=value2" -o path/to/output
Kimia Zhu
la source
12

Sous Windows OS étant donné le programme ci-dessous

package main

import "fmt"

var (
    version string
    date    string
)

func main() {
    fmt.Printf("version=%s, date=%s", version, date)
}

Vous pouvez construire en utilisant

go build -ldflags "-X main.version=0.0.1 -X main.date=%date:~10,4%-%date:~4,2%-%date:~7,2%T%time:~0,2%:%time:~3,2%:%time:~6,2%"

Le format de date suppose que votre environnement echo %date%est Fri 07/22/2016et echo %time%est16:21:52.88

Ensuite, la sortie sera: version=0.0.1, date=2016-07-22T16:21:52

Ostati
la source