examples

README

go-git: examples

Here you can find a list of annotated go-git examples:

Basic

• showcase - A small showcase of the capabilities of go-git.
• open - Opening a existing repository cloned by git.
• clone - Cloning a repository.
  • username and password - Cloning a repository using a username and password.
  • personal access token - Cloning a repository using a GitHub personal access token.
  • ssh private key - Cloning a repository using a ssh private key.
• commit - Commit changes to the current branch to an existent repository.
• push - Push repository to default remote (origin).
• pull - Pull changes from a remote repository.
• checkout - Check out a specific commit from a repository.
• log - Emulate git log command output iterating all the commit history from HEAD reference.
• branch - How to create and remove branches or any other kind of reference.
• tag - List/print repository tags.
• tag create and push - Create and push a new tag.
• tag find if head is tagged - Find if HEAD is tagged.
• remotes - Working with remotes: adding, removing, etc.
• progress - Printing the progress information from the sideband.
• revision - Solve a revision into a commit.
• config - Explains how to work with config files.
• submodule - Submodule update remote.

Advanced

• custom_http - Replacing the HTTP client using a custom one.
• clone with context - Cloning a repository with graceful cancellation.
• storage - Implementing a custom storage system.

Documentation

Index

• func CheckArgs(arg ...string)
• func CheckIfError(err error)
• func Info(format string, args ...interface{})
• func Warning(format string, args ...interface{})

Functions

func CheckArgs

func CheckArgs(arg ...string)

CheckArgs should be used to ensure the right command line arguments are passed before executing an example.

func CheckIfError

func CheckIfError(err error)

CheckIfError should be used to naively panics if an error is not nil.

func Info

func Info(format string, args ...interface{})

Info should be used to describe the example commands that are about to run.

func Warning

func Warning(format string, args ...interface{})

Warning should be used to display a warning