Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >

Search





Overview

The GoPublishModule native step publishes GO (GoLang) modules to an Artifactory repository.


Page Contents


YAML Schema

The YAML schema for DockerBuild native step is as follows:

GoPublishModule
pipelines: 
  - name:   <string>
    steps:
      - name: <string>
        type: GoPublishModule
        configuration:
          #inherits all the tags from bash; https://www.jfrog.com/confluence/display/JFROG/Bash

          forceXrayScan:        <boolean>         # optional
          failOnScan:           <boolean>         # default true
          autoPublishBuildInfo: <boolean>         # optional
          
          # for payloadType module:
          sourceLocation: <string>                # optional
          version: <string>                       # required
          targetRepository: <string>              # required
          self: <boolean>                         # optional
          deps: <string>                          # optional 
          
		  integrations:
            - name:         <artifactory integration>  # required if autoPublishBuildInfo is false
          inputResources:
            - name:         <gitrepo resource>         # required
            - name:         <filespec resource>        # optional
          outputResources:
            - name:         <buildinfo resource>       # required if autoPublishBuildInfo is true

        execution:
          onStart:
            - echo "Preparing for work..."
          onSuccess:
            - echo "Job well done!"
          onFailure:
            - echo "uh oh, something went wrong"
          onComplete:                                  #always
            - echo "Cleaning up some stuff"




Tags

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 pertinent tags:

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 GitRepo resourceThe 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 when autoPublishBuildInfo is set to true

If  JFROG_CLI_BUILD_NAME or JFROG_CLI_BUILD_NUMBER is 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 buildName and buildNumber are $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
sourceLocationLocation 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
versionVersion of the module to build. Required
targetRepositoryRepository in the Artifactory where the module will be published.Required
selfWhen true, uses the --self option to publish the project to Artifactory. For more information, see the CLI for JFrog Artifactory documentation.Optional
depsWhen specified, uses the --deps option to specify a list of project dependencies to Artifactory. For more information, see the CLI for JFrog Artifactory documentation.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 Build checkbox is checked, 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:
TagDescription of usageRequired/Optional
onStartCommands to execute in advance of the native operationOptional
onSuccessCommands to execute on successful completionOptional
onFailureCommands to execute on failed completionOptional
onCompleteCommands to execute on any completionOptional


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

Examples

The following examples show how to configure a GoPublishModule step.

Full Pipeline Example

# This config file is templatized so that it can be easily customized. Values can be provided with a values.yml file.
template: true   # required for local templates
valuesFilePath: ./values.yml

resources:
  # Sample Go app in a GitRepo
  - name: go_repo
    type: GitRepo
    configuration:
      path: {{ .Values.repoPath }}
      branches:
        include: main
      gitProvider: {{ .Values.gitProvider }}

  # Build info for the published Go app
  - name: go_buildinfo
    type: BuildInfo
    configuration:
      sourceArtifactory: {{ .Values.artifactory }}    

pipelines:
  - name: go_publish_binary_example
    steps:
      # Build the Go sample app from the GitRepo. Docs at https://www.jfrog.com/confluence/display/JFROG/GoBuild
      - name: build_go
        type: GoBuild
        configuration:
          sourceLocation: .
          resolverRepo: go-virtual
          noRegistry: true
          inputResources:
            - name: go_repo
          integrations:
            - name: {{ .Values.artifactory }}
             
      # Publish the Go sample app binary to Artifactory
      - name: cicd_go_publish_binary
        type: GoPublishBinary
        configuration:
          # forceXrayScan: true
          # failOnScan: false
          autoPublishBuildInfo: true
          inputSteps:
            - name: build_go
          targetRepository: go-local
          integrations:
            - name: myArtifactory
          outputResources:
            - name: go_buildinfo

Using Default Locations

A GoPublishModule step using default locations and publishing version v0.0.0 to an Artifactory repository named go-repo.

GoPublishModule
pipelines: 
  - name: goPublishModulePipeline
    steps:
      - name: goPublishModuleStep
        type: GoPublishModule
        configuration: 
          version: "v0.0.0"
          targetRepository: go-repo
          inputResources:
            - name: gitRepoResource
          integrations:
            - name: artifactory_integration

Different Source Location in the GitRepo

A GoPublishModule step specifying a different source location in the GitRepo and publishing the project and dependencies to the Artifactory repository named go-repo as well.

GoPublishModule
pipelines: 
  - name: goPublishModulePipeline
    steps:
      - name: goPublishModuleStep
        type: GoPublishModule
        configuration: 
          version: "v0.0.${run_number}"
          targetRepository: go-repo
          self: true
          deps: ALL
          inputResources:
            - name: gitRepoResource
          integrations:
            - name: artifactory_integration

Publish Build Info and Trigger Xray Scan

A GoPublishModule step that publishes the build info and triggers an Xray scan. 

GoPublishModule
pipelines: 
  - name: goPublishModulePipeline
    steps:
      - name: goPublishModuleStep
        type: GoPublishModule
        configuration: 
          version: "v0.0.${run_number}"
          targetRepository: go-repo
          autoPublishBuildInfo: true
          forceXrayScan: true
          inputResources:
            - name: gitRepoResource
          outputResources:
            - name: outputBuildInfo
          integrations:
            - name: artifactory_integration

How it Works

When you use the GoPublishModule native step in a pipeline, it performs the following functions in the background:

  • jfrog rt config (if there is an output BuildInfo resource, configure the JFrog CLI with the Artifactory credentials in that resource)
  • jfrog rt use (to set the current default Artifactory configuration )
  • cp (if there is an input FileSpec, copy the files to the root of the cloned GitRepo)
  • jfrog rt go-config (configure the repository to resolve dependencies)
  • jfrog rt go-publish (publish)
  • add_run_variables (save information about this step for future steps)
  • jfrog rt build-collect-env (collect environment variables)
  • jfrog rt build-publish (if autoPublishBuildInfo is true, publish the build info)
  • write_output (if autoPublishBuildInfo is true, update the output resource)
  • jfrog rt build-scan (if forceXrayScan is true, trigger a scan)
  • add_run_files (save the build information in the run state for later publish steps)
  • No labels
Copyright © 2021 JFrog Ltd.