kick

README

kick: git sync automator

ABOUT

kick automates a common git workflow:

1. Stage all local changes.
2. Commit all local changes.
3. Pull remote changes and tags.
4. Push local changes.
5. Push tags and changes.

EXAMPLE

$ kick

See kick -help for more options.

DOWNLOAD

https://github.com/mcandre/kick/releases

INSTALL FROM SOURCE

$ go install github.com/mcandre/kick/cmd/kick@latest

DOCUMENTATION

https://pkg.go.dev/github.com/mcandre/kick

LICENSE

BSD-2-Clause

RUNTIME REQUIREMENTS

• git 2.46.1+

CONFIGURATION

See CONFIGURATION.md.

CONTRIBUTING

For more information on developing buttery itself, see DEVELOPMENT.md.

👟

Documentation

Overview

Package kick provides high level git sync operations.

Index

• Constants
• type Config
  • func NewConfig() Config
  • func (o Config) Commit() error
  • func (o Config) EnsureNonce() error
  • func (o Config) FetchTags() error
  • func (o Config) Kick() error
  • func (o Config) Pull() error
  • func (o Config) Push() error
  • func (o Config) PushTags() error
  • func (o *Config) QueryRemotes() error
  • func (o Config) Stage() error

Constants

const CommitMessageEnvironmentVariable = "KICK_MESSAGE"

CommitMessageEnvironmentVariable denotes the name of the environment variable controlling commit messages.

const DefaultCommitMessage = "up"

DefaultCommitMessage denotes a standard commit message.

const FetchAllEnvironmentVariable = "KICK_FETCH_ALL"

FetchAllEnvironmentVariable denotes the name of the environment variable controlling whether fetches process all remotes.

const NonceEnvironmentVariable = "KICK_NONCE"

NonceEnvironmentVariable denotes the name of the environment variable controlling nonces.

const NoncePath = ".kick"

NoncePath denotes the file path to a nonce file, relative to the current working directory.

const PullAllEnvironmentVariable = "KICK_PULL_ALL"

PullAllEnvironmentVariable denotes the name of the environment variable controlling whether pulls process all remotes.

const PushAllEnvironmentVariable = "KICK_PUSH_ALL"

PushAllEnvironmentVariable denotes the name of the environment variable controlling whether pushes process all remotes.

const SyncTagsEnvironmentVariable = "KICK_SYNC_TAGS"

SyncTagsEnvironmentVariable denotes the name of the environment variable controlling whether to push and pull tags.

const Version = "0.0.8"

Version is semver.

Types

type Config

type Config struct {
	// Debug enables additional logging (default: false).
	Debug bool

	// Nonce enables altering NoncePath to generate commits when repositories are otherwise unchanged (default: false).
	Nonce bool

	// FetchAll enables fetching from all remotes (default: true).
	FetchAll bool

	// PullAll enables pulling from all remotes (default: true).
	PullAll bool

	// PushAll enables pushing to all remotes (default: true).
	PushAll bool

	// SyncTags enables pushing and pulling tags (default: true).
	SyncTags bool

	// CommitMessage denotes a git commit message (default: DefaultCommitMessage).
	CommitMessage string
	// contains filtered or unexported fields
}

Config prepares high level git sync operations.

func NewConfig

func NewConfig() Config

NewConfig constructs a Config.

func (Config) Commit

func (o Config) Commit() error

Commit commits any staged changes.

func (Config) EnsureNonce

func (o Config) EnsureNonce() error

EnsureNonce updates NoncePath with the current timestamp.

func (Config) FetchTags

func (o Config) FetchTags() error

FetchTags fetches any remote tags.

func (Config) Kick

func (o Config) Kick() error

Kick automates:

* Staging all file changes * Committing all changes * Pulling any remote changes * Pushing any local changes * Pulling and pushing tags

func (Config) Pull

func (o Config) Pull() error

Pull pulls any remote changes.

func (Config) Push

func (o Config) Push() error

Push pushes any local changes.

func (Config) PushTags

func (o Config) PushTags() error

PushTags pushes any local tags.

func (*Config) QueryRemotes

func (o *Config) QueryRemotes() error

QueryRemotes populates metadata for remotes.

func (Config) Stage

func (o Config) Stage() error

Stage stages any local file changes.