Documentation
¶
Index ¶
- Constants
- type Changelog
- type GitHubClient
- type Github
- func (g *Github) Add(files []string) error
- func (g *Github) Changelog(version version.Version) (string, error)
- func (g *Github) Checkout() error
- func (g *Github) Clean() error
- func (g *Github) Clone() (string, error)
- func (g *Github) Commit(message string) error
- func (g *Github) GetChangedFiles(workingDir string) ([]string, error)
- func (g *Github) GetDirectory() (directory string)
- func (g *Github) Init(source string, pipelineID string) error
- func (g *Github) Push() error
- func (g *Github) PushTag(tag string) error
- func (g *Github) SearchReleases() (releases []string, err error)
- func (g *Github) SearchTags() (tags []string, err error)
- type GithubHandler
- type MockGitHubClient
- type PageInfo
- type PullRequest
- type PullRequestApi
- type PullRequestSpec
- type RateLimit
- type Spec
Constants ¶
const PULLREQUESTBODY = `
# {{ .Title }}
{{ if .Introduction }}
{{ .Introduction }}
{{ end }}
## Report
{{ .Report }}
## Changelog
<details><summary>Click to expand</summary>
` + "````\n{{ .Description }}\n````" + `
</details>
## Remark
This pull request was automatically created using [Updatecli](https://www.updatecli.io).
Please report any issues with this tool [here](https://github.com/updatecli/updatecli/issues/new)
`
PULLREQUESTBODY is the pull request template used as pull request description Please note that triple backticks are concatenated with the literals, as they cannot be escaped
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitHubClient ¶ added in v0.19.0
type GitHubClient interface {
Query(ctx context.Context, q interface{}, variables map[string]interface{}) error
Mutate(ctx context.Context, m interface{}, input githubv4.Input, variables map[string]interface{}) error
}
GitHubClient must be implemented by any GitHub query client (v4 API)
type Github ¶
type Github struct {
Spec Spec // Spec contains inputs coming from updatecli configuration
HeadBranch string // remoteBranch is used when creating a temporary branch before opening a PR
Force bool // Force is used during the git push phase to run `git push --force`.
CommitMessage commit.Commit // CommitMessage represents conventional commit metadata as type or scope, used to generate the final commit message.
// contains filtered or unexported fields
}
Github contains settings to interact with Github
func (*Github) GetChangedFiles ¶ added in v0.12.0
func (*Github) GetDirectory ¶
GetDirectory returns the local git repository path.
func (*Github) Push ¶
Push run `git push` then open a pull request on Github if not already created.
func (*Github) SearchReleases ¶
SearchReleases return every releases from the github api ordered by reverse order of created time. Draft and pre-releases are filtered out.
func (*Github) SearchTags ¶
SearchTags return every tags from the github api return in reverse order of commit tags.
type GithubHandler ¶ added in v0.19.0
type GithubHandler interface {
SearchReleases() (releases []string, err error)
SearchTags() (tags []string, err error)
Changelog(version.Version) (string, error)
}
GithubHandler must be implemented by any GitHub module
type MockGitHubClient ¶ added in v0.19.0
type MockGitHubClient struct {
// contains filtered or unexported fields
}
type PullRequest ¶
type PullRequest struct {
Description string
Report string
Title string
// contains filtered or unexported fields
}
func NewPullRequest ¶ added in v0.17.0
func NewPullRequest(spec PullRequestSpec, gh *Github) (PullRequest, error)
func (*PullRequest) CreatePullRequest ¶ added in v0.17.0
func (p *PullRequest) CreatePullRequest(title, changelog, pipelineReport string) error
func (*PullRequest) EnablePullRequestAutoMerge ¶ added in v0.19.0
func (p *PullRequest) EnablePullRequestAutoMerge() error
EnablePullRequestAutoMerge updates an existing pullrequest with the flag automerge
func (*PullRequest) GetPullRequestLabelsInformation ¶ added in v0.17.0
func (p *PullRequest) GetPullRequestLabelsInformation() ([]repositoryLabelApi, error)
getPullRequestLabelsInformation queries GitHub Api to retrieve every labels assigned to a pullRequest
func (*PullRequest) OpenPullRequest ¶ added in v0.17.0
func (p *PullRequest) OpenPullRequest() error
OpenPullRequest creates a new pull request on Github.
type PullRequestApi ¶ added in v0.17.0
type PullRequestApi struct {
BaseRefName string
Body string
HeadRefName string
ID string
State string
Title string
Url string
Number int
}
PullRequest contains multiple fields mapped to Github V4 api
type PullRequestSpec ¶ added in v0.14.0
type PullRequestSpec struct {
AutoMerge bool // Specify if automerge is enabled for the new pullrequest
Title string // Specify pull request title
Description string // Description contains user input description used during pull body creation
Labels []string // Specify repository labels used for pull request. !! They must already exist
Draft bool // Define if a pull request is set to draft, default false
MaintainerCannotModify bool // Define if maintainer can modify pullRequest
}
PullRequestSpec is a specific struct containing pullrequest settings provided by an updatecli configuration
type Spec ¶ added in v0.10.0
type Spec struct {
Branch string // Branch specifies which github branch to work on
Directory string // Directory specifies where the github repisotory is cloned on the local disk
Email string // Email specifies which emails to use when creating commits
Owner string // Owner specifies repository owner
Repository string // Repository specifies the name of a repository for a specific owner
Version string // **Deprecated** Version is deprecated in favor of `versionFilter.pattern`, this field will be removed in a future version
VersionFilter version.Filter //VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
Token string // Token specifies the credential used to authenticate with
URL string // URL specifies the default github url in case of GitHub enterprise
Username string // Username specifies the username used to authenticate with Github API
User string // User specific the user in git commit messages
PullRequest PullRequestSpec // Deprecated since https://github.com/updatecli/updatecli/issues/260, must be clean up
}
Spec represents the configuration input
func (*Spec) SpecToPullRequestSpec ¶ added in v0.17.0
func (s *Spec) SpecToPullRequestSpec() interface{}
SpecToPullRequestSpec is a function that export the pullRequest spec from a GithubSpec to a PullRequest.Spec. It's temporary function until we totally remove the old scm configuration introduced by this https://github.com/updatecli/updatecli/pull/388