githubsetup

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

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

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"`
}