GoPublishModule - Tags

JFrog Pipelines Documentation

ft:sourceType
Paligo

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

name

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

type

Must be GoPublishModule 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 pertinenttags:

Tag

Description of usage

Required/Optional

integrations

Specifies an Artifactory Integration. Required when autoPublishBuildInfo is set to false. Otherwise, the Artifactory integration specified in the BuildInfo resource will be used.

May be required

inputResources

Must specify a GitReporesource. The publish commands will run on the Git repository at sourceLocation.

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

Required

Optional

outputResources

Must specify a BuildInfo resource whenautoPublishBuildInfois set to true.

If JFROG_CLI_BUILD_NAMEor JFROG_CLI_BUILD_NUMBERis set as an environment variable for the pipeline or the step, that name and/or number is used for the output BuildInfo. Otherwise, the default buildNameand buildNumberare $pipeline_name and $run_number respectively.

May be required

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 of the Go source files relative to the root of the input GitRepo repository. If not specified, the default is the root of the GitRepo repository.

Optional

version

Version of the module to build.

Required

targetRepository

Repository in the Artifactory where the module will be published.

Required

resolverRepo

Name of the Artifactory repository to be used to resolve dependencies.

Optional

self

When true, uses the --self option to publish the Project to Artifactory. For more information, see the CLI for JFrog Artifactory documentation. Not supported with JFrog CLI v2.

Optional

deps

When specified, uses the --deps option to specify a list of project dependencies to Artifactory. For more information, see the CLI for JFrog Artifactory documentation. Not supported with JFrog CLI v2.

Optional

forceXrayScan

When set to true, force an Xray scan after publishing to Artifactory.

Default is false.

Optional

failOnScan

When set to true, and when the Xray Policy Rule Fail BuildConfigure a Security Rule checkbox is checked in the Configure a Security Rule window, a failed Xray scan will result in a failure of the step.

Default is true.

Optional

autoPublishBuildInfo

When set to true, automatically publish the implicitly created BuildInfo.

Default is false.

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.