githubsetup

package

v0.0.0-...-dc022f5 Latest Latest Go to latest Published: Jul 10, 2026 License: MIT Imports: 8 Imported by: 0

Details

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

Repository

github.com/Rememorio/codog

Links

Open Source Insights

Documentation ¶

Overview ¶

Package githubsetup creates Codog-compatible GitHub Actions setup reports.

Index ¶

Constants
type Options
type Report
- func Setup(opts Options) (Report, error)
type WorkflowFile

Constants ¶

View Source

const (
	DefaultSecretName = "ANTHROPIC_API_KEY"
	DocsURL           = "https://github.com/anthropics/claude-code-action/blob/main/docs/setup.md"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	Workspace  string
	SecretName string
	Workflows  []string
	Force      bool
	DryRun     bool
}

type Report ¶

type Report struct {
	Kind         string         `json:"kind"`
	Action       string         `json:"action"`
	Status       string         `json:"status"`
	Workspace    string         `json:"workspace"`
	Repo         string         `json:"repo,omitempty"`
	SecretName   string         `json:"secret_name"`
	DryRun       bool           `json:"dry_run"`
	DocsURL      string         `json:"docs_url"`
	Workflows    []WorkflowFile `json:"workflows"`
	Instructions []string       `json:"instructions"`
	Warnings     []string       `json:"warnings,omitempty"`
}

func Setup ¶

func Setup(opts Options) (Report, error)

type WorkflowFile ¶

type WorkflowFile struct {
	Name        string `json:"name"`
	Path        string `json:"path"`
	Exists      bool   `json:"exists"`
	Created     bool   `json:"created"`
	Overwritten bool   `json:"overwritten"`
}

Source Files ¶

View all Source files

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