Golang go.mod

kind: golang/gomod

source	condition	target
✔	✔	✔

source

condition

target

✔

source

The Golang "gomod" "source" retrieves the Golang module version matching the versioning rule or the Golang version specified in the go.mod file.

condition

The Golang "gomod" "condition" checks if the Golang module version matching the versioning rule exist or the Golang version exists in the go.mod file.

target

The Golang "gomod" "target" ensures the Golang module version matching the versioning rule or the Golang version is correctly set in the go.mod file.

Important

The gomod target doesn’t clean and update the file go.sum. It needs to be handled separately by running go mod tidy such as in the example below.

Parameter

Name	Type	Description
file	string	File defines the go.mod file, default to “go.mod” compatible: source condition remark: scheme “https://”, “http://”, and “file://” are supported in path for source and condition
indirect	boolean	Indirect specifies if we manipulate an indirect dependency compatible: source condition
module	string	Module defines the module path compatible: source condition remark: scheme “https://”, “http://”, and “file://” are supported in path for source and condition
replace	boolean	Replace specifies if we manipulate a replaced dependency compatible: source condition target
replaceversion	string	ReplaceVersion specifies the specific Go module version to replace compatible: source condition target default: unset, which will match any version of the module being replaced. Example: For the following Go replace instruction: moduleA v1.2.3 => moduleB v1.0.0 The ‘module’ field should be set to ‘moduleA’ (the module being replaced, left-hand side). The value of ReplaceVersion should be ‘v1.2.3’, corresponding to the version of moduleA (the module being replaced, left-hand side).
version	string	Version Defines a specific golang version compatible: source condition

Example

# updatecli.yaml
name: "Interact with go.mod"

scms:
  updatecli:
    kind: github
    spec:
      owner: updatecli
      repository: updatecli
      username: '{{ requiredEnv "GITHUB_ACTOR" }}'
      token: '{{ requiredEnv "GITHUB_TOKEN" }}'

sources:
  default:
    kind: golang/gomod
    name: Get module version used in go.mod
    scmid: updatecli
    spec:
      module: github.com/Masterminds/semver/v3

  golang:
    kind: golang/gomod
    name: Get Golang version used in go.mod
    scmid: updatecli
    spec:
      kind: golang

conditions:
  default:
    disablesourceinput: true
    kind: golang/gomod
    name: Ensure github.com/Masterminds/semver/v3 module version is v3.2.0
    scmid: updatecli
    spec:
      module: github.com/Masterminds/semver/v3
      file: pkg/plugins/resources/go/gomod/testdata/go.mod
      version: "v3.2.0"

  goversion:
    kind: golang/gomod
    name: Ensure golang version is set to value retrieved from source golang
    scmid: updatecli
    sourceid: golang
    spec:
      kind: golang

targets:
  default:
    disablesourceinput: true
    kind: golang/gomod
    name: Ensure github.com/Masterminds/semver/v3 module is set to v3.2.0
    scmid: updatecli
    spec:
      module: github.com/Masterminds/semver/v3
      file: pkg/plugins/resources/go/gomod/testdata/go.mod
      version: "v3.2.0"

  goversion:
    kind: golang/gomod
    name: Ensure Golang version is set based on source "default"
    scmid: updatecli
    sourceid: golang
    spec:
      file: pkg/plugins/resources/go/gomod/testdata/go.mod
      kind: golang

  # Its' important to notice that the gomod plugin do not run the command 
  # `go mod tidy` which need to be handled in a different stage such as
  goModTidy:
    dependson:
      - goversion
      - default
    disablesourceinput: true
    kind: shell
    name: Run `go mod tidy`
    spec:
      changedif:
        kind: file/checksum
        spec:
          files:
            - go.mod
            - go.sum
      command: go mod tidy
      environments:
        - name: HOME
        - name: PATH
    scmid: updatecli

Last modified on April 18, 2023

Edit this page on GitHub