cisetup

Documentation

Index

• Constants
• Variables
• type BaseStepConfiguration
• type BuildInfoResourceConfiguration
  • func (b BuildInfoResourceConfiguration) ResourceConfigurationMarkerFunction()
• type BuildOn
• type CiSetupData
  • func (sd *CiSetupData) GetRepoFullName() string
• type CiType
• type CustomImage
• type GitProvider
• type GitRepoResourceConfiguration
  • func (g GitRepoResourceConfiguration) ResourceConfigurationMarkerFunction()
• type GithubActionsGenerator
  • func (gg *GithubActionsGenerator) Generate() (githubActionsBytes []byte, githubActionsName string, err error)
• type GradleIndicator
  • func (gi GradleIndicator) GetTechnology() Technology
  • func (gi GradleIndicator) Indicates(file string) bool
• type GradleStepConfiguration
• type IncludeExclude
• type InputStep
• type JFrogPipelinesConfigurator
  • func (pc *JFrogPipelinesConfigurator) Config() (vcsIntName, rtIntName string, err error)
• type JFrogPipelinesYamlGenerator
  • func (yg *JFrogPipelinesYamlGenerator) Generate() (pipelineBytes []byte, pipelineName string, err error)
• type JenkinsfileGenerator
  • func (jg *JenkinsfileGenerator) Generate() (jenkinsfileBytes []byte, jenkinsfileName string, err error)
• type MavenIndicator
  • func (mi MavenIndicator) GetTechnology() Technology
  • func (mi MavenIndicator) Indicates(file string) bool
• type MavenStepConfiguration
• type NativeStepConfiguration
• type NpmIndicator
  • func (ni NpmIndicator) GetTechnology() Technology
  • func (ni NpmIndicator) Indicates(file string) bool
• type Pipeline
• type PipelineConfiguration
• type PipelineEnvVars
• type PipelineStep
• type PipelineYml
• type Resource
• type ResourceConfiguration
• type ResourceType
• type Runtime
• type RuntimeImage
• type RuntimeType
• type StepConfiguration
• type StepExecution
• type StepIntegration
• type StepResource
• type StepType
• type Technology
• type TechnologyIndicator
  • func GetTechIndicators() []TechnologyIndicator
• type TechnologyInfo
• type VcsServerDetails

Constants

const (
	Github           = "GitHub"
	GithubEnterprise = "GitHub Enterprise"
	Bitbucket        = "Bitbucket"
	BitbucketServer  = "Bitbucket Server"
	Gitlab           = "GitLab"
)

const (
	Jenkins       = "Jenkins"
	GithubActions = "GitHub Actions"
	Pipelines     = "JFrog Pipelines"
)

const (
	MvnBuild         StepType = "MvnBuild"
	GradleBuild               = "GradleBuild"
	NpmBuild                  = "NpmBuild"
	Bash                      = "Bash"
	PublishBuildInfo          = "PublishBuildInfo"
)

const (
	Maven  = "Maven"
	Gradle = "Gradle"
	Npm    = "npm"
)

const ConfigServerId = "ci-setup-cmd"

const GithubActionsFileName = "build.yml"

const JenkinsfileName = "Jenkinsfile"

const (
	PipelinesYamlName = "pipelines.yml"
)

Variables

var GithubActionsDir = filepath.Join(".github", "workflows")

var GithubActionsFilePath = filepath.Join(GithubActionsDir, GithubActionsFileName)

Types

type BaseStepConfiguration

type BaseStepConfiguration struct {
	EnvironmentVariables map[string]string `yaml:"environmentVariables,omitempty"`
	Integrations         []StepIntegration `yaml:"integrations,omitempty"`
	InputResources       []StepResource    `yaml:"inputResources,omitempty"`
	OutputResources      []StepResource    `yaml:"outputResources,omitempty"`
	InputSteps           []InputStep       `yaml:"inputSteps,omitempty"`
}

type BuildInfoResourceConfiguration

type BuildInfoResourceConfiguration struct {
	SourceArtifactoryIntegration string      `yaml:"sourceArtifactory,omitempty"`
	BuildName                    string      `yaml:"buildName,omitempty"`
	BuildNumber                  json.Number `yaml:"buildNumber,omitempty"`
}

func (BuildInfoResourceConfiguration) ResourceConfigurationMarkerFunction

func (b BuildInfoResourceConfiguration) ResourceConfigurationMarkerFunction()

type BuildOn

type BuildOn struct {
	PullRequestCreate bool `yaml:"pullRequestCreate,omitempty"`
	Commit            bool `yaml:"commit,omitempty"`
}

type CiSetupData

type CiSetupData struct {
	RepositoryName string
	ProjectDomain  string
	VcsBaseUrl     string
	LocalDirPath   string
	GitBranch      string
	BuildName      string
	CiType         CiType
	// A collection of the technologies that were detected in the project.
	DetectedTechnologies map[Technology]bool
	// The chosen build technology stored with all the necessary information.
	BuiltTechnology *TechnologyInfo
	VcsCredentials  VcsServerDetails
	GitProvider     GitProvider
}

func (*CiSetupData) GetRepoFullName

func (sd *CiSetupData) GetRepoFullName() string

type CiType

type CiType string

type CustomImage

type CustomImage struct {
	Name             string `yaml:"name,omitempty"`
	Tag              string `yaml:"tag,omitempty"`
	Options          string `yaml:"options,omitempty"`
	Registry         string `yaml:"registry,omitempty"`
	SourceRepository string `yaml:"sourceRepository,omitempty"`
	Region           string `yaml:"region,omitempty"`
}

type GitProvider

type GitProvider string

type GitRepoResourceConfiguration

type GitRepoResourceConfiguration struct {
	Path        string `yaml:"path,omitempty"`
	GitProvider string `yaml:"gitProvider,omitempty"`
	BuildOn     `yaml:"buildOn,omitempty"`
	Branches    IncludeExclude `yaml:"branches,omitempty"`
}

func (GitRepoResourceConfiguration) ResourceConfigurationMarkerFunction

func (g GitRepoResourceConfiguration) ResourceConfigurationMarkerFunction()

type GithubActionsGenerator

type GithubActionsGenerator struct {
	SetupData *CiSetupData
}

func (*GithubActionsGenerator) Generate

func (gg *GithubActionsGenerator) Generate() (githubActionsBytes []byte, githubActionsName string, err error)

type GradleIndicator

type GradleIndicator struct {
}

func (GradleIndicator) GetTechnology

func (gi GradleIndicator) GetTechnology() Technology

func (GradleIndicator) Indicates

func (gi GradleIndicator) Indicates(file string) bool

type GradleStepConfiguration

type GradleStepConfiguration struct {
	NativeStepConfiguration `yaml:",inline"`
	GradleCommand           string `yaml:"gradleCommand,omitempty"`
	ResolverRepo            string `yaml:"resolverRepo,omitempty"`
	UsesPlugin              bool   `yaml:"usesPlugin,omitempty"`
	UseWrapper              bool   `yaml:"useWrapper,omitempty"`
}

type IncludeExclude

type IncludeExclude struct {
	Include string `yaml:"include,omitempty"`
	Exclude string `yaml:"exclude,omitempty"`
}

type InputStep

type InputStep struct {
	Name string `yaml:"name,omitempty"`
}

type JFrogPipelinesConfigurator

type JFrogPipelinesConfigurator struct {
	SetupData      *CiSetupData
	PipelinesToken string
}

func (*JFrogPipelinesConfigurator) Config

func (pc *JFrogPipelinesConfigurator) Config() (vcsIntName, rtIntName string, err error)

type JFrogPipelinesYamlGenerator

type JFrogPipelinesYamlGenerator struct {
	VcsIntName string
	RtIntName  string
	SetupData  *CiSetupData
}

func (*JFrogPipelinesYamlGenerator) Generate

func (yg *JFrogPipelinesYamlGenerator) Generate() (pipelineBytes []byte, pipelineName string, err error)

type JenkinsfileGenerator

type JenkinsfileGenerator struct {
	SetupData *CiSetupData
}

func (*JenkinsfileGenerator) Generate

func (jg *JenkinsfileGenerator) Generate() (jenkinsfileBytes []byte, jenkinsfileName string, err error)

type MavenIndicator

type MavenIndicator struct {
}

func (MavenIndicator) GetTechnology

func (mi MavenIndicator) GetTechnology() Technology

func (MavenIndicator) Indicates

func (mi MavenIndicator) Indicates(file string) bool

type MavenStepConfiguration

type MavenStepConfiguration struct {
	NativeStepConfiguration `yaml:",inline"`
	MvnCommand              string `yaml:"mvnCommand,omitempty"`
	ResolverSnapshotRepo    string `yaml:"resolverSnapshotRepo,omitempty"`
	ResolverReleaseRepo     string `yaml:"resolverReleaseRepo,omitempty"`
	DeployerSnapshotRepo    string `yaml:"deployerSnapshotRepo,omitempty"`
	DeployerReleaseRepo     string `yaml:"deployerReleaseRepo,omitempty"`
}

type NativeStepConfiguration

type NativeStepConfiguration struct {
	BaseStepConfiguration `yaml:",inline"`
	ForceXrayScan         bool `yaml:"forceXrayScan,omitempty"`
	FailOnScan            bool `yaml:"failOnScan,omitempty"`
	AutoPublishBuildInfo  bool `yaml:"autoPublishBuildInfo,omitempty"`
}

type NpmIndicator

type NpmIndicator struct {
}

func (NpmIndicator) GetTechnology

func (ni NpmIndicator) GetTechnology() Technology

func (NpmIndicator) Indicates

func (ni NpmIndicator) Indicates(file string) bool

type Pipeline

type Pipeline struct {
	Name          string                `yaml:"name,omitempty"`
	Configuration PipelineConfiguration `yaml:"configuration,omitempty"`
	Steps         []PipelineStep        `yaml:"steps,omitempty"`
}

type PipelineConfiguration

type PipelineConfiguration struct {
	Runtime         `yaml:"runtime,omitempty"`
	PipelineEnvVars `yaml:"environmentVariables,omitempty"`
}

type PipelineEnvVars

type PipelineEnvVars struct {
	ReadOnlyEnvVars map[string]string `yaml:"readOnly,omitempty"`
}

type PipelineStep

type PipelineStep struct {
	Name          string `yaml:"name,omitempty"`
	StepType      `yaml:"type,omitempty"`
	Configuration StepConfiguration `yaml:"configuration,omitempty"`
	Execution     StepExecution     `yaml:"execution,omitempty"`
}

type PipelineYml

type PipelineYml struct {
	Resources []Resource `yaml:"resources,omitempty"`
	Pipelines []Pipeline `yaml:"pipelines,omitempty"`
}

type Resource

type Resource struct {
	Name                  string `yaml:"name,omitempty"`
	ResourceType          `yaml:"type,omitempty"`
	ResourceConfiguration `yaml:"configuration,omitempty"`
}

type ResourceConfiguration

type ResourceConfiguration interface {
	ResourceConfigurationMarkerFunction()
}

type ResourceType

type ResourceType string

const (
	GitRepo   ResourceType = "GitRepo"
	BuildInfo ResourceType = "BuildInfo"
)

type Runtime

type Runtime struct {
	RuntimeType `yaml:"type,omitempty"`
	Image       RuntimeImage `yaml:"image,omitempty"`
}

type RuntimeImage

type RuntimeImage struct {
	Custom CustomImage `yaml:"custom,omitempty"`
}

type RuntimeType

type RuntimeType string

const (
	Image RuntimeType = "image"
)

type StepConfiguration

type StepConfiguration interface {
	// contains filtered or unexported methods
}

type StepExecution

type StepExecution struct {
	OnStart    []string `yaml:"onStart,omitempty"`
	OnExecute  []string `yaml:"onExecute,omitempty"`
	OnComplete []string `yaml:"onComplete,omitempty"`
	OnSuccess  []string `yaml:"onSuccess,omitempty"`
	OnFailure  []string `yaml:"onFailure,omitempty"`
}

type StepIntegration

type StepIntegration struct {
	Name string `yaml:"name,omitempty"`
}

type StepResource

type StepResource struct {
	Name string `yaml:"name,omitempty"`
}

type StepType

type StepType string

type Technology

type Technology string

type TechnologyIndicator

type TechnologyIndicator interface {
	GetTechnology() Technology
	Indicates(file string) bool
}

func GetTechIndicators

func GetTechIndicators() []TechnologyIndicator

type TechnologyInfo

type TechnologyInfo struct {
	Type        Technology
	VirtualRepo string
	BuildCmd    string
}

type VcsServerDetails

type VcsServerDetails struct {
	Url         string `json:"url,omitempty"`
	User        string `json:"user,omitempty"`
	Password    string `json:"-"`
	AccessToken string `json:"-"`
}