write

package

v8.85.1 Latest Latest Go to latest Published: Sep 22, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

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

Repository

github.com/giantswarm/devctl

Links

Open Source Insights

Documentation ¶

Overview ¶

Package write is what the team-file writes share -- adopt, update, transfer, set-lifecycle: one call to a write tool of giantswarm-repo-manager with dryRun or mode commit, the plan printed on a dry run and the outcome on a commit.

Index ¶

Constants
func Run(ctx context.Context, session *client.Session, w io.Writer, f *Flags, ...) error
type Flags
- func (f *Flags) Args(args map[string]any) map[string]any
- func (f *Flags) Init(cmd *cobra.Command, what string)

Constants ¶

View Source

const CallTimeout = 2 * time.Minute

CallTimeout bounds a write: the manager's writes run on GitHub within the call and may take up to a minute.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(ctx context.Context, session *client.Session, w io.Writer, f *Flags, tool string, args map[string]any) error

Run calls tool with args and prints the plan (a dry run) or the outcome (a commit), or the answer as it came.

Types ¶

type Flags ¶

type Flags struct {
	client.Flags
	DryRun bool
	Reason string
}

Flags are the flags every write takes: the output, --dry-run and --reason.

func (*Flags) Args ¶

func (f *Flags) Args(args map[string]any) map[string]any

Args completes a write's arguments with the reason and dryRun or mode.

func (*Flags) Init ¶

func (f *Flags) Init(cmd *cobra.Command, what string)

Init registers the flags; what says what the dry run leaves unwritten.

Source Files ¶

View all Source files

write.go

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