jx: github.com/jenkins-x/jx/pkg/cmd/step Index | Files | Directories

package step

import "github.com/jenkins-x/jx/pkg/cmd/step"

Index

Package Files

step_blog.go step_changelog.go step_credential.go step_custom_pipeline.go step_gpg_credentials.go step_link_services.go step_next_buildnumber.go step_next_version.go step_override_requirements.go step_release.go step_replicate.go step_split_monorepo.go step_stash.go step_tag.go step_unstash.go step_validate.go step_values_schema_template.go step_wait_for_artifact.go

Constants

const (
    ReleaseName = `{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}`

    SpecName    = `{{ .Chart.Name }}`
    SpecVersion = `{{ .Chart.Version }}`

    ReleaseCrdYaml = "" /* 526 byte string literal not displayed */

)
const (
    VERSION = "version"

    ValuesYamlRepositoryPrefix = "  repository:"
    ValuesYamlTagPrefix        = "  tag:"
)
const (
    DefaultMavenCentralRepo = "http://central.maven.org/maven2/"
)
const (

    // Description common text for long command descriptions around storage
    Description = `
Annotates a secret or configmap so it can be replicated across an environment
`
)
const (
    StorageSupportDescription = "" /* 269 byte string literal not displayed */

)

Variables

var (
    GitAccessDescription = "" /* 365 byte string literal not displayed */

    StepChangelogLong = templates.LongDesc("" /* 1551 byte string literal not displayed */,
    ) + GitAccessDescription

    StepChangelogExample = templates.Examples("" /* 265 byte string literal not displayed */,
    )

    GitHubIssueRegex = regexp.MustCompile(`(\#\d+)`)
    JIRAIssueRegex   = regexp.MustCompile(`[A-Z][A-Z]+-(\d+)`)
)
var (
    StepGpgCredentialsLong = templates.LongDesc(`
		This pipeline step generates GPG credentials files from the ` + kube.SecretJenkinsReleaseGPG + ` secret

`)

    StepGpgCredentialsExample = templates.Examples("" /* 187 byte string literal not displayed */,
    )
)
var (
    StepLinkServicesLong = templates.LongDesc("" /* 129 byte string literal not displayed */,
    )

    StepLinkServicesExample = templates.Examples("" /* 505 byte string literal not displayed */,
    )
)
var (
    StepNextBuildNumberLong = templates.LongDesc(`
		Generates the next build unique number for a pipeline
`)

    StepNextBuildNumberExample = templates.Examples(`
		jx step next-buildnumber 
`)
)
var (
    StepNextVersionLong = templates.LongDesc(`
		This pipeline step command works out a semantic version, writes a file ./VERSION and optionally updates a file
`)

    StepNextVersionExample = templates.Examples("" /* 330 byte string literal not displayed */,
    )
)
var (
    StepWaitForArtifactLong = templates.LongDesc(`
		Waits for the given artifact to be available in a maven style repository

`)

    StepWaitForArtifactExample = templates.Examples("" /* 139 byte string literal not displayed */,
    )
)

func CollapseDependencyUpdates Uses

func CollapseDependencyUpdates(dependencyUpdates []v1.DependencyUpdate) []v1.DependencyUpdate

CollapseDependencyUpdates takes a raw set of dependencyUpdates, removes duplicates and collapses multiple updates to the same org/repo:components into a sungle update

func CreateBucketHTTPFn Uses

func CreateBucketHTTPFn(authSvc auth.ConfigService) func(string) (string, error)

CreateBucketHTTPFn creates a function to transform a git URL to add the token for accessing a git based bucket

func GetTokenForGitURL Uses

func GetTokenForGitURL(authSvc auth.ConfigService, u string) (string, error)

GetTokenForGitURL returns the git token for the given git URL

func NewCmdStepBlog Uses

func NewCmdStepBlog(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepBlog Creates a new Command object

func NewCmdStepChangelog Uses

func NewCmdStepChangelog(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepCredential Uses

func NewCmdStepCredential(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepCredential creates the command

func NewCmdStepCustomPipeline Uses

func NewCmdStepCustomPipeline(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepCustomPipeline creates the new command

func NewCmdStepGpgCredentials Uses

func NewCmdStepGpgCredentials(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepLinkServices Uses

func NewCmdStepLinkServices(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepLinkServices Creates a new Command object

func NewCmdStepNextBuildNumber Uses

func NewCmdStepNextBuildNumber(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepNextVersion Uses

func NewCmdStepNextVersion(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepOverrideRequirements Uses

func NewCmdStepOverrideRequirements(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepOverrideRequirements creates the `jx step verify pod` command

func NewCmdStepRelease Uses

func NewCmdStepRelease(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStep Steps a command object for the "step" command

func NewCmdStepReplicate Uses

func NewCmdStepReplicate(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepReplicate creates the CLI command

func NewCmdStepSplitMonorepo Uses

func NewCmdStepSplitMonorepo(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSplitMonorepo Creates a new Command object

func NewCmdStepStash Uses

func NewCmdStepStash(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepStash creates the CLI command

func NewCmdStepTag Uses

func NewCmdStepTag(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStepUnstash Uses

func NewCmdStepUnstash(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepUnstash creates the CLI command

func NewCmdStepValidate Uses

func NewCmdStepValidate(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepValidate Creates a new Command object

func NewCmdStepValuesSchemaTemplate Uses

func NewCmdStepValuesSchemaTemplate(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepValuesSchemaTemplate Creates a new Command object

func NewCmdStepWaitForArtifact Uses

func NewCmdStepWaitForArtifact(commonOpts *opts.CommonOptions) *cobra.Command

type PackageJSON Uses

type PackageJSON struct {
    Version string `json:"version"`
}

type Project Uses

type Project struct {
    Version string `xml:"version"`
}

type ReplicateOptions Uses

type ReplicateOptions struct {
    step.StepOptions
    ReplicateToNamepace []string
    CreateNamespace     bool
}

ReplicateOptions contains the command line flags

func (*ReplicateOptions) Run Uses

func (o *ReplicateOptions) Run() error

Run runs the command

type StepBlogOptions Uses

type StepBlogOptions struct {
    step.StepOptions

    FromDate                    string
    ToDate                      string
    Dir                         string
    BlogOutputDir               string
    BlogName                    string
    CombineMinorReleases        bool
    DeveloperChannelMemberCount int
    UserChannelMemberCount      int

    State StepBlogState
}

StepBlogOptions contains the command line flags

func (*StepBlogOptions) CreateChatProvider Uses

func (o *StepBlogOptions) CreateChatProvider(chatConfig *config.ChatConfig) (chats.ChatProvider, error)

CreateChatProvider creates a new chart provider from the given configuration

func (*StepBlogOptions) Run Uses

func (o *StepBlogOptions) Run() error

Run implements this command

type StepBlogState Uses

type StepBlogState struct {
    GitInfo                  *gits.GitRepository
    GitProvider              gits.GitProvider
    Tracker                  issues.IssueProvider
    Release                  *v1.Release
    BlogFileName             string
    DeveloperChatMetricsName string
    UserChatMetricsName      string
    Buffer                   *bytes.Buffer
    Writer                   *bufio.Writer
    HistoryService           *reports.ProjectHistoryService
    History                  *reports.ProjectHistory
    NewContributors          map[string]*v1.UserDetails
    NewCommitters            map[string]*v1.UserDetails
}

type StepChangelogOptions Uses

type StepChangelogOptions struct {
    step.StepOptions

    PreviousRevision    string
    PreviousDate        string
    CurrentRevision     string
    TemplatesDir        string
    ReleaseYamlFile     string
    CrdYamlFile         string
    Dir                 string
    Version             string
    Build               string
    Header              string
    HeaderFile          string
    Footer              string
    FooterFile          string
    OutputMarkdownFile  string
    OverwriteCRD        bool
    GenerateCRD         bool
    GenerateReleaseYaml bool
    UpdateRelease       bool
    NoReleaseInDev      bool
    IncludeMergeCommits bool
    FailIfFindCommits   bool
    State               StepChangelogState
}

StepChangelogOptions contains the command line flags

func (*StepChangelogOptions) Run Uses

func (o *StepChangelogOptions) Run() error

type StepChangelogState Uses

type StepChangelogState struct {
    GitInfo         *gits.GitRepository
    GitProvider     gits.GitProvider
    Tracker         issues.IssueProvider
    FoundIssueNames map[string]bool
    LoggedIssueKind bool
    Release         *v1.Release
}

type StepCredentialOptions Uses

type StepCredentialOptions struct {
    step.StepOptions

    Namespace string
    Secret    string
    Key       string
    File      string
    Optional  bool
}

StepCredentialOptions contains the command line arguments for this command

func (*StepCredentialOptions) Run Uses

func (o *StepCredentialOptions) Run() error

Run runs the command

type StepCustomPipelineOptions Uses

type StepCustomPipelineOptions struct {
    step.StepOptions

    MultiBranchProject bool
    Dir                string
    Jenkinsfile        string
    JenkinsPath        string
    JenkinsSelector    opts.JenkinsSelectorOptions
}

StepCustomPipelineOptions contains the command line arguments for this command

func (*StepCustomPipelineOptions) Run Uses

func (o *StepCustomPipelineOptions) Run() error

Run implements the command

type StepGpgCredentialsOptions Uses

type StepGpgCredentialsOptions struct {
    step.StepOptions

    OutputDir string
}

StepGpgCredentialsOptions contains the command line flags

func (*StepGpgCredentialsOptions) GenerateGpgFiles Uses

func (o *StepGpgCredentialsOptions) GenerateGpgFiles(secret *v1.Secret) error

func (*StepGpgCredentialsOptions) Run Uses

func (o *StepGpgCredentialsOptions) Run() error

type StepLinkServicesOptions Uses

type StepLinkServicesOptions struct {
    step.StepOptions
    FromNamespace string
    ToNamespace   string
    Includes      []string
    Excludes      []string
}

StepLinkServicesOptions contains the command line flags

func (*StepLinkServicesOptions) Run Uses

func (o *StepLinkServicesOptions) Run() error

Run implements this command

type StepNextBuildNumberOptions Uses

type StepNextBuildNumberOptions struct {
    step.StepOptions

    Owner      string
    Repository string
    Branch     string
}

StepNextBuildNumberOptions contains the command line flags

func (*StepNextBuildNumberOptions) Run Uses

func (o *StepNextBuildNumberOptions) Run() error

type StepNextVersionOptions Uses

type StepNextVersionOptions struct {
    Filename        string
    Dir             string
    Tag             bool
    UseGitTagOnly   bool
    NewVersion      string
    SemanticRelease bool
    step.StepOptions
}

StepNextVersionOptions contains the command line flags

func (*StepNextVersionOptions) GetVersion Uses

func (o *StepNextVersionOptions) GetVersion() (string, error)

GetVersion gets the version from a source file

func (*StepNextVersionOptions) Run Uses

func (o *StepNextVersionOptions) Run() error

func (*StepNextVersionOptions) SetVersion Uses

func (o *StepNextVersionOptions) SetVersion() error

SetVersion Sets the version...

type StepOverrideRequirementsOptions Uses

type StepOverrideRequirementsOptions struct {
    *opts.CommonOptions
    Dir string
}

StepOverrideRequirementsOptions contains the command line flags

func (*StepOverrideRequirementsOptions) Run Uses

func (o *StepOverrideRequirementsOptions) Run() error

Run implements this command

type StepReleaseOptions Uses

type StepReleaseOptions struct {
    step.StepOptions

    DockerRegistry string
    Organisation   string
    Application    string
    Version        string
    GitUsername    string
    GitEmail       string
    Dir            string
    XdgConfigHome  string
    NoBatch        bool

    // promote flags
    Build               string
    Timeout             string
    PullRequestPollTime string
    LocalHelmRepoName   string
    HelmRepositoryURL   string
}

StepReleaseOptions contains the CLI arguments

func (*StepReleaseOptions) Run Uses

func (o *StepReleaseOptions) Run() error

Run implements this command

func (*StepReleaseOptions) Setenv Uses

func (o *StepReleaseOptions) Setenv(key string, value string) error

type StepSplitMonorepoOptions Uses

type StepSplitMonorepoOptions struct {
    step.StepOptions

    Glob          string
    Organisation  string
    RepoName      string
    Dir           string
    OutputDir     string
    KubernetesDir string
    NoGit         bool
}

StepSplitMonorepoOptions contains the command line flags

func (*StepSplitMonorepoOptions) Run Uses

func (o *StepSplitMonorepoOptions) Run() error

Run implements this command

type StepStashOptions Uses

type StepStashOptions struct {
    step.StepOptions
    Pattern         []string
    Dir             string
    ToPath          string
    Basedir         string
    StorageLocation jenkinsv1.StorageLocation
    ProjectGitURL   string
    ProjectBranch   string
}

StepStashOptions contains the command line flags

func (*StepStashOptions) Run Uses

func (o *StepStashOptions) Run() error

Run runs the command

type StepTagFlags Uses

type StepTagFlags struct {
    Version              string
    VersionFile          string
    Dir                  string
    ChartsDir            string
    ChartValueRepository string
    NoApply              bool
}

type StepTagOptions Uses

type StepTagOptions struct {
    step.StepOptions

    Flags StepTagFlags
}

CreateClusterOptions the flags for running create cluster

func (*StepTagOptions) Run Uses

func (o *StepTagOptions) Run() error

type StepUnstashOptions Uses

type StepUnstashOptions struct {
    step.StepOptions

    URL     string
    OutDir  string
    Timeout time.Duration
}

StepUnstashOptions contains the command line flags

func (*StepUnstashOptions) Run Uses

func (o *StepUnstashOptions) Run() error

Run runs the command

type StepValidateOptions Uses

type StepValidateOptions struct {
    step.StepOptions

    MinimumJxVersion string
    Dir              string
}

StepValidateOptions contains the command line flags

func (*StepValidateOptions) Run Uses

func (o *StepValidateOptions) Run() error

Run implements this command

type StepValuesSchemaTemplateOptions Uses

type StepValuesSchemaTemplateOptions struct {
    step.StepOptions

    ConfigMapName string
    ConfigMapKey  string
    Set           []string
}

StepValuesSchemaTemplateOptions contains the command line flags

func (*StepValuesSchemaTemplateOptions) Run Uses

func (o *StepValuesSchemaTemplateOptions) Run() error

Run implements this command

type StepWaitForArtifactOptions Uses

type StepWaitForArtifactOptions struct {
    step.StepOptions

    ArtifactURL string
    RepoURL     string
    GroupId     string
    ArtifactId  string
    Version     string
    Extension   string
    Timeout     string
    PollTime    string

    // calculated fields
    TimeoutDuration time.Duration
    PollDuration    time.Duration
}

StepWaitForArtifactOptions contains the command line flags

func (*StepWaitForArtifactOptions) Run Uses

func (o *StepWaitForArtifactOptions) Run() error

Directories

PathSynopsis
boot
buildpack
cluster
create
create/pr
e2e
env
expose
get
git
helm
nexus
post
pr
pre
report
scheduler
syntax
update
update/release
verify

Package step imports 62 packages (graph) and is imported by 4 packages. Updated 2019-09-17. Refresh now. Tools for package owners.