platforms

package
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 11, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ClonePath = ".gonovate-clone"

Functions

This section is empty.

Types

type GitHubPlatform 

type GitHubPlatform struct {
	*GitPlatform
}

func NewGitHubPlatform 

func NewGitHubPlatform(settings *common.PlatformSettings) *GitHubPlatform

func (*GitHubPlatform) Cleanup 

func (p *GitHubPlatform) Cleanup(cleanupSettings *PlatformCleanupSettings) error

func (*GitHubPlatform) FetchProject 

func (p *GitHubPlatform) FetchProject(project *common.Project) error

func (*GitHubPlatform) LookupAuthor added in v0.10.3 

func (p *GitHubPlatform) LookupAuthor() (string, string, error)

func (*GitHubPlatform) NotifyChanges 

func (p *GitHubPlatform) NotifyChanges(project *common.Project, updateGroup *common.UpdateGroup) error

func (*GitHubPlatform) Type 

func (p *GitHubPlatform) Type() common.PlatformType

type GitPlatform 

type GitPlatform struct {
	// contains filtered or unexported fields
}

func NewGitPlatform 

func NewGitPlatform(settings *common.PlatformSettings) *GitPlatform

func (*GitPlatform) Cleanup 

func (p *GitPlatform) Cleanup(cleanupSettings *PlatformCleanupSettings) error

func (*GitPlatform) FetchProject 

func (p *GitPlatform) FetchProject(project *common.Project) error

func (*GitPlatform) IsNewOrChanged added in v0.9.0 

func (p *GitPlatform) IsNewOrChanged(updateGroup *common.UpdateGroup) (bool, error)

func (*GitPlatform) LookupAuthor added in v0.10.3 

func (p *GitPlatform) LookupAuthor() (string, string, error)

func (*GitPlatform) NotifyChanges 

func (p *GitPlatform) NotifyChanges(project *common.Project, updateGroup *common.UpdateGroup) error

func (*GitPlatform) PrepareForChanges 

func (p *GitPlatform) PrepareForChanges(updateGroup *common.UpdateGroup) error

func (*GitPlatform) PublishChanges 

func (p *GitPlatform) PublishChanges(updateGroup *common.UpdateGroup) error

func (*GitPlatform) ResetToBase 

func (p *GitPlatform) ResetToBase(baseBranch string) error

func (*GitPlatform) SubmitChanges 

func (p *GitPlatform) SubmitChanges(updateGroup *common.UpdateGroup) error

func (*GitPlatform) Type 

func (p *GitPlatform) Type() common.PlatformType

type GiteaPlatform added in v0.8.0 

type GiteaPlatform struct {
	*GitPlatform
}

func NewGiteaPlatform added in v0.8.0 

func NewGiteaPlatform(settings *common.PlatformSettings) *GiteaPlatform

func (*GiteaPlatform) Cleanup added in v0.8.0 

func (p *GiteaPlatform) Cleanup(cleanupSettings *PlatformCleanupSettings) error

func (*GiteaPlatform) FetchProject added in v0.8.0 

func (p *GiteaPlatform) FetchProject(project *common.Project) error

func (*GiteaPlatform) LookupAuthor added in v0.10.3 

func (p *GiteaPlatform) LookupAuthor() (string, string, error)

func (*GiteaPlatform) NotifyChanges added in v0.8.0 

func (p *GiteaPlatform) NotifyChanges(project *common.Project, updateGroup *common.UpdateGroup) error

func (*GiteaPlatform) Type added in v0.8.0 

func (p *GiteaPlatform) Type() common.PlatformType

type GitlabPlatform 

type GitlabPlatform struct {
	*GitPlatform
}

func NewGitlabPlatform 

func NewGitlabPlatform(settings *common.PlatformSettings) *GitlabPlatform

func (*GitlabPlatform) Cleanup 

func (p *GitlabPlatform) Cleanup(cleanupSettings *PlatformCleanupSettings) error

func (*GitlabPlatform) FetchProject 

func (p *GitlabPlatform) FetchProject(project *common.Project) error

func (*GitlabPlatform) LookupAuthor added in v0.10.3 

func (p *GitlabPlatform) LookupAuthor() (string, string, error)

func (*GitlabPlatform) NotifyChanges 

func (p *GitlabPlatform) NotifyChanges(project *common.Project, updateGroup *common.UpdateGroup) error

func (*GitlabPlatform) Type 

func (p *GitlabPlatform) Type() common.PlatformType

type IPlatform 

type IPlatform interface {
	// Returns the type of the platform
	Type() common.PlatformType
	// Fetches the project from the platform in it's initial state.
	FetchProject(project *common.Project) error
	// Prepares the project to accept changes.
	PrepareForChanges(updateGroup *common.UpdateGroup) error
	// Looks up the author to use for commits.
	LookupAuthor() (string, string, error)
	// Submit the changes to the project locally.
	SubmitChanges(updateGroup *common.UpdateGroup) error
	// Checks if the remote already has the same changes.
	IsNewOrChanged(updateGroup *common.UpdateGroup) (bool, error)
	// Publishes the changes to the remote location.
	PublishChanges(updateGroup *common.UpdateGroup) error
	// Notifies the remote about the changes with eg. MRs/PRs.
	NotifyChanges(project *common.Project, updateGroup *common.UpdateGroup) error
	// Resets the project to the initial state for other changes.
	ResetToBase(baseBranch string) error
	// Cleans the platform after a gonovate run.
	Cleanup(cleanupSettings *PlatformCleanupSettings) error
}

func GetPlatform 

func GetPlatform(settings *common.PlatformSettings) (IPlatform, error)

func NewNoopPlatform 

func NewNoopPlatform(settings *common.PlatformSettings) IPlatform

type NoopPlatform 

type NoopPlatform struct {
	// contains filtered or unexported fields
}

func (*NoopPlatform) Cleanup 

func (p *NoopPlatform) Cleanup(cleanupSettings *PlatformCleanupSettings) error

func (*NoopPlatform) FetchProject 

func (p *NoopPlatform) FetchProject(project *common.Project) error

func (*NoopPlatform) IsNewOrChanged added in v0.9.0 

func (p *NoopPlatform) IsNewOrChanged(updateGroup *common.UpdateGroup) (bool, error)

func (*NoopPlatform) LookupAuthor added in v0.10.3 

func (p *NoopPlatform) LookupAuthor() (string, string, error)

func (*NoopPlatform) NotifyChanges 

func (p *NoopPlatform) NotifyChanges(project *common.Project, updateGroup *common.UpdateGroup) error

func (*NoopPlatform) PrepareForChanges 

func (p *NoopPlatform) PrepareForChanges(updateGroup *common.UpdateGroup) error

func (*NoopPlatform) PublishChanges 

func (p *NoopPlatform) PublishChanges(updateGroup *common.UpdateGroup) error

func (*NoopPlatform) ResetToBase 

func (p *NoopPlatform) ResetToBase(baseBranch string) error

func (*NoopPlatform) SubmitChanges 

func (p *NoopPlatform) SubmitChanges(updateGroup *common.UpdateGroup) error

func (*NoopPlatform) Type 

func (p *NoopPlatform) Type() common.PlatformType

type PlatformCleanupSettings 

type PlatformCleanupSettings struct {
	Project      *common.Project
	UpdateGroups []*common.UpdateGroup
	BaseBranch   string
	BranchPrefix string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.