-
Pierre Smeyers authoredPierre Smeyers authored
GitLab CI template for Go
This project implements a generic GitLab CI template for Go.
It provides several features, usable in different modes (by configuration).
Usage
In order to include this template in your project, add the following to your gitlab-ci.yml:
include:
- project: 'Orange-OpenSource/tbc/golang'
ref: '1.0.0'
file: '/templates/gitlab-ci-golang.yml'Global configuration
The Go template uses some global configuration used throughout all jobs.
| Name | description | default value |
|---|---|---|
GO_IMAGE |
The Docker image used to run Go for go-build
|
golang:buster |
GO_TEST_IMAGE |
The Docker image used to run Go for go-test
|
none |
GOPROXY |
URL of Go module proxy | none |
Jobs
build & test jobs
Build and tests can be done in separate jobs.
If GO_TEST_IMAGE is not set (default), the go-build-test job will run build and tests at once.
If GO_TEST_IMAGE is set, separate go-build and go-test jobs will be run in the build phase in parallel.
Separating buildand test jobs can be useful to use different images (and hence different tools) .
These jobs use the following variable:
| Name | description | default value |
|---|---|---|
GO_BUILD_ARGS |
Arguments used by the build command | install -mod=readonly ./... |
GO_TEST_ARGS |
Arguments used by the test command | test -mod=readonly -v -coverprofile=reports/coverage.out -race ./... |
GO_LIST_ARGS |
Arguments used by the list command | list -u -m -mod=readonly -json all |
go-ci-lint job
This job enables a manual GolangCI-Lint analysis.
It is bound to the build stage, and uses the following variables:
| Name | description | default value |
|---|---|---|
GO_CI_LINT_IMAGE |
The Docker image used to run golangci-lint
|
golangci/golangci-lint:latest-alpine |
GO_CI_LINT_ARGS |
golangci-lint command line arguments
|
-E gosec,goimports ./... |
Golang Security Checker can be a long operation and therefore the job is configured to be ran manually by default (overridable).
go-mod-outdated job
This job enables a manual Go-mod-outdated analysis.
It is bound to the test stage, and uses the following variables:
| Name | description | default value |
|---|---|---|
GO_MOD_OUTDATED_ARGS |
god-mod-outdated command line arguments
|
-update -direct -style markdown -ci |
Checking outdated modules can be a long operation and therefore the job is configured to be ran manually by default (overridable).
SonarQube analysis
If you're using the SonarQube template to analyse your Go code, here is a sample sonar-project.properties file:
# see: https://docs.sonarqube.org/latest/analysis/languages/go/
# set your source directory(ies) here (relative to the sonar-project.properties file)
sonar.sources=.
# exclude unwanted directories and files from being analysed
sonar.exclusions=bin/**,**/*_test.go,**/vendor/**
# set your tests directory(ies) here (relative to the sonar-project.properties file)
sonar.tests=.
sonar.test.inclusions=**/*_test.go
sonar.test.exclusions=**/vendor/**
# tests report: JSON format
sonar.go.tests.reportPaths=reports/sonar-tests-report.json
# coverage report
sonar.go.coverage.reportPaths=reports/coverage.out
# golanci-lint report
sonar.go.golangci-lint.reportPaths=reports/golangci-lint-report.xmlMore info:
