github

package

v0.0.0-...-aaf700e Latest Latest Go to latest Published: Jan 15, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vince-riv/argo-diff

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Comment(ctx context.Context, owner, repo string, prNum int, sha string, ...) ([]*github.IssueComment, error)
func ConnectivityCheck() error
func GetPullRequest(ctx context.Context, owner, repo string, prNum int) (*github.PullRequest, error)
func IsRefreshComment(comment string) bool
func ListPullRequestFiles(ctx context.Context, owner, repo string, prNum int) ([]string, error)
func Status(ctx context.Context, ...) error
type ArgoAppMarkdown
- func (a *ArgoAppMarkdown) AddResourceDiff(group, kind, name, ns, diffStr string)
- func (a ArgoAppMarkdown) OverviewStr(continued bool) string
type CommentMarkdown
- func (c *CommentMarkdown) AppMarkdown(appName, warnStr string, syncStatus string, healthStatus string, ...) *ArgoAppMarkdown
- func (c CommentMarkdown) String() []string

Constants ¶

View Source

const StatusError = "error"

View Source

const StatusFailure = "failure"

View Source

const StatusPending = "pending"

View Source

const StatusSuccess = "success"

Variables ¶

This section is empty.

Functions ¶

func Comment ¶

func Comment(ctx context.Context, owner, repo string, prNum int, sha string, commentBodies []string) ([]*github.IssueComment, error)

Creates or updates comment on the specified pull request

func ConnectivityCheck ¶

func ConnectivityCheck() error

func GetPullRequest ¶

func GetPullRequest(ctx context.Context, owner, repo string, prNum int) (*github.PullRequest, error)

Gets the specified pull request

func IsRefreshComment ¶

func IsRefreshComment(comment string) bool

func ListPullRequestFiles ¶

func ListPullRequestFiles(ctx context.Context, owner, repo string, prNum int) ([]string, error)

Returns list of files in a pull request

func Status ¶

func Status(ctx context.Context, status, description, repoOwner, repoName, commitSha string, dryRun bool) error

Helper that sets commit status for the request commit sha

Types ¶

type ArgoAppMarkdown ¶

type ArgoAppMarkdown struct {
	AppName      string
	WarnStr      string
	SyncStatus   string
	HealthStatus string
	HealthMsg    string
	Preamble     string
	Resources    []string
	Closing      string
}

func (*ArgoAppMarkdown) AddResourceDiff ¶

func (a *ArgoAppMarkdown) AddResourceDiff(group, kind, name, ns, diffStr string)

func (ArgoAppMarkdown) OverviewStr ¶

func (a ArgoAppMarkdown) OverviewStr(continued bool) string

type CommentMarkdown ¶

type CommentMarkdown struct {
	Preamble string
	ArgoApps []ArgoAppMarkdown
	Closing  string
}

func (*CommentMarkdown) AppMarkdown ¶

func (c *CommentMarkdown) AppMarkdown(appName, warnStr string, syncStatus string, healthStatus string, healthMsg string) *ArgoAppMarkdown

func (CommentMarkdown) String ¶

func (c CommentMarkdown) String() []string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL