GoBuild - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

This topic lists tags that can be used with GoBuild Pipeline steps. For more information on GoBuild Pipeline steps, see GoBuild.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be GoBuild for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:

Tag	Description of usage	Required/Optional
`integrations`	Specifies an Artifactory Integration or JFrog Platform Access Token Integration where modules will be published. If a FileSpec resource is specified in `inputResources` then this is optional. Otherwise, it is required.	May be required
`inputResources`	Must specify a GitRepo resource that has Go source files in `sourceLocation`. Also may specify an optional FileSpec resource that specifies what files to copy to `sourceLocation`to build.	Required Optional

Tag

Description of usage

Required/Optional

integrations

Specifies an Artifactory Integration or JFrog Platform Access Token Integration where modules will be published. If a FileSpec resource is specified in inputResources then this is optional. Otherwise, it is required.

May be required

inputResources

Must specify a GitRepo resource that has Go source files in sourceLocation.

Also may specify an optional FileSpec resource that specifies what files to copy to sourceLocationto build.

Required

Optional

In addition, these tags can be defined to support the step's native operation:

Tags derived from Bash

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag	Description of usage	Required/Optional
`sourceLocation`	Location where the Go source files are available, relative to the root of the GitRepo repository. If not specified, the default is the root of the GitRepo repository.	Optional
`outputLocation`	Location where the built Go modules should be published.	Optional
`outputFile`	File that has the output of the Go command. The default filename is the name of the step.	Optional
`resolverRepo`	Name of the Artifactory repository to be used to resolve dependencies.	Optional
`repository`	Alternative to `resolverRepo`. Only one of these options may be specified.	Optional
`goCommand`	Specifies a command line string of options to use with the Go client. Default: `build -o $outputLocation/$outputFile`	Optional

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.