Skip to content
Snippets Groups Projects
Commit 72bfee8e authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 9a8ce865
Branches
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 6 additions and 6 deletions
README.md
+ 6
− 6
View file @ 72bfee8e
...@@ -17,7 +17,7 @@ include: ...@@ -17,7 +17,7 @@ include:
The Go template uses some global configuration used throughout all jobs. The Go template uses some global configuration used throughout all jobs.
| Name | description | default value | | Name | Description | Default value |
|------------------|------------------------------------------------------------------------------------------------------------|-----------------| |------------------|------------------------------------------------------------------------------------------------------------|-----------------|
| `GO_IMAGE` | The Docker image used to run Go for `go-build` <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/library/golang:buster` | | `GO_IMAGE` | The Docker image used to run Go for `go-build` <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/library/golang:buster` |
| `GO_TEST_IMAGE` | The Docker image used to run Go for `go-test` <br/>:warning: **set the version required by your project** | _none_ | | `GO_TEST_IMAGE` | The Docker image used to run Go for `go-test` <br/>:warning: **set the version required by your project** | _none_ |
...@@ -68,7 +68,7 @@ go-build: ...@@ -68,7 +68,7 @@ go-build:
These jobs use the following variable: These jobs use the following variable:
| Name | description | default value | | Name | Description | Default value |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| |-------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| `GO_BUILD_MODE` | The template build mode (accepted values are `application`, `modules` and `auto`) | `auto` | | `GO_BUILD_MODE` | The template build mode (accepted values are `application`, `modules` and `auto`) | `auto` |
| `GO_BUILD_FLAGS` | Flags used by the [go build command](https://pkg.go.dev/cmd/go#hdr-Compile_packages_and_dependencies) | `-mod=readonly` | | `GO_BUILD_FLAGS` | Flags used by the [go build command](https://pkg.go.dev/cmd/go#hdr-Compile_packages_and_dependencies) | `-mod=readonly` |
...@@ -97,7 +97,7 @@ This job enables a manual [GolangCI-Lint](https://github.com/golangci/golangci-l ...@@ -97,7 +97,7 @@ This job enables a manual [GolangCI-Lint](https://github.com/golangci/golangci-l
It is bound to the `build` stage, and uses the following variables: It is bound to the `build` stage, and uses the following variables:
| Name | description | default value | | Name | Description | Default value |
|-----------------------|----------------------------------------------------------------------------------------------------------|----------------------------------------| |-----------------------|----------------------------------------------------------------------------------------------------------|----------------------------------------|
| `GO_CI_LINT_IMAGE` | The Docker image used to run `golangci-lint` | `registry.hub.docker.com/golangci/golangci-lint:latest-alpine` | | `GO_CI_LINT_IMAGE` | The Docker image used to run `golangci-lint` | `registry.hub.docker.com/golangci/golangci-lint:latest-alpine` |
| `GO_CI_LINT_ARGS` | `golangci-lint` [command line arguments](https://github.com/golangci/golangci-lint#command-line-options) | `-E gosec,goimports ./...` | | `GO_CI_LINT_ARGS` | `golangci-lint` [command line arguments](https://github.com/golangci/golangci-lint#command-line-options) | `-E gosec,goimports ./...` |
...@@ -116,7 +116,7 @@ This job enables a manual [Go-mod-outdated](https://github.com/psampaz/go-mod-ou ...@@ -116,7 +116,7 @@ This job enables a manual [Go-mod-outdated](https://github.com/psampaz/go-mod-ou
It is bound to the `test` stage, and uses the following variables: It is bound to the `test` stage, and uses the following variables:
| Name | description | default value | | Name | Description | Default value |
|------------------------|-----------------------------------------------------------------------------------------------|-------------------| |------------------------|-----------------------------------------------------------------------------------------------|-------------------|
| `GO_MOD_OUTDATED_ARGS` | `god-mod-outdated` [command line arguments](https://github.com/psampaz/go-mod-outdated#usage) | `-update -direct` | | `GO_MOD_OUTDATED_ARGS` | `god-mod-outdated` [command line arguments](https://github.com/psampaz/go-mod-outdated#usage) | `-update -direct` |
...@@ -161,7 +161,7 @@ This job generates a [SBOM](https://cyclonedx.org/) file listing installed packa ...@@ -161,7 +161,7 @@ This job generates a [SBOM](https://cyclonedx.org/) file listing installed packa
It is bound to the `test` stage, and uses the following variables: It is bound to the `test` stage, and uses the following variables:
| Name | description | default value | | Name | Description | Default value |
| --------------------- | -------------------------------------- | ----------------- | | --------------------- | -------------------------------------- | ----------------- |
| `GO_SBOM_DISABLED` | Set to `true` to disable this job | _none_ | | `GO_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |
| `GO_SBOM_IMAGE` | Image of cyclonedx-gomod used for SBOM analysis | `registry.hub.docker.com/cyclonedx/cyclonedx-gomod:latest` | | `GO_SBOM_IMAGE` | Image of cyclonedx-gomod used for SBOM analysis | `registry.hub.docker.com/cyclonedx/cyclonedx-gomod:latest` |
...@@ -182,7 +182,7 @@ This job enables Vulnerability Management with [Govulncheck](https://go.dev/blog ...@@ -182,7 +182,7 @@ This job enables Vulnerability Management with [Govulncheck](https://go.dev/blog
It is bound to the `test` stage, and uses the following variables: It is bound to the `test` stage, and uses the following variables:
| Name | description | default value | | Name | Description | Default value |
| --------------------- | -------------------------------------- | ----------------- | | --------------------- | -------------------------------------- | ----------------- |
| `GO_VULNCHECK_DISABLED` | Set to `true` to disable this job | _none_ | `GO_VULNCHECK_DISABLED` | Set to `true` to disable this job | _none_
| `GO_VULNCHECK_ARGS` | `govulncheck` [command line arguments](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck#hdr-Flags) | `./...` | | `GO_VULNCHECK_ARGS` | `govulncheck` [command line arguments](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck#hdr-Flags) | `./...` |
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment