Documentation
¶
Index ¶
- type Spec
- type Stash
- func (g *Stash) Add(files []string) error
- func (g *Stash) Checkout() error
- func (g *Stash) Clean() error
- func (g *Stash) Clone() (string, error)
- func (g *Stash) Commit(message string) error
- func (g *Stash) GetChangedFiles(workingDir string) ([]string, error)
- func (g *Stash) GetDirectory() (directory string)
- func (g *Stash) IsRemoteBranchUpToDate() (bool, error)
- func (g *Stash) Push() error
- func (g *Stash) PushBranch(branch string) error
- func (g *Stash) PushTag(tag string) error
- func (g *Stash) SearchTags() (tags []string, err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Spec ¶
type Spec struct {
client.Spec `yaml:",inline,omitempty"`
// CommitMessage represents conventional commit metadata as type or scope, used to generate the final commit message.
CommitMessage commit.Commit `yaml:",omitempty"`
// Directory specifies where the github repository is cloned on the local disk
Directory string `yaml:",omitempty"`
// Email specifies which emails to use when creating commits
Email string `yaml:",omitempty"`
// Force is used during the git push phase to run `git push --force`.
Force bool `yaml:",omitempty"`
// GPG key and passphrased used for commit signing
GPG sign.GPGSpec `yaml:",omitempty"`
// Owner specifies repository owner
Owner string `yaml:",omitempty" jsonschema:"required"`
// Repository specifies the name of a repository for a specific owner
Repository string `yaml:",omitempty" jsonschema:"required"`
// User specifies the user of the git commit messages
User string `yaml:",omitempty"`
// Branch specifies which Bitbucket repository branch to work on
Branch string `yaml:",omitempty"`
}
Spec defines settings used to interact with Bitbucket release
type Stash ¶
type Stash struct {
// Spec contains inputs coming from updatecli configuration
Spec Spec
HeadBranch string
// contains filtered or unexported fields
}
Stash contains information to interact with Stash api
func (*Stash) GetChangedFiles ¶
func (*Stash) GetDirectory ¶
GetDirectory returns the local git repository path.
func (*Stash) IsRemoteBranchUpToDate ¶
IsRemoteBranchUpToDate checks if the branche reference name is published on on the default remote
func (*Stash) Push ¶
Push run `git push` to the corresponding Bitbucket remote branch if not already created.
func (*Stash) SearchTags ¶
Retrieve git tags from a remote bitbucket repository
Click to show internal directories.
Click to hide internal directories.