gogit

use git add git commit git push with "github.com/go-git/go-git/v5".

README

中文说明

Installation

go get github.com/go-xlan/gogit

Usage

Initializing the Git Client

First, create a new Git client instance by calling the New function with the repository's root directory:

package main

import (
	"fmt"
	"log"

	"github.com/go-xlan/gogit"
)

func main() {
	client := gogit.MustNew("/path/to/your/repository")
	fmt.Println("Git client initialized!")
}

Adding All Changes

To add all changes (including deletions) to the Git index (staging area), use the AddAll method:

err := client.AddAll()
done.Done(err)

Viewing Git Status

To view the current status of the working tree, use the Status method:

status, err := client.Status()
done.Done(err)

fmt.Println("Git Status: ", status)

Committing Changes

To commit all changes, use the CommitAll method. You need to provide a CommitInfo struct, which defines the commit message and signature.

commitInfo := gogit.CommitInfo{
	Name:    "Your Name",
	Eddress:  "[email protected]",
	Message: "Your commit message",
}

commitHash, err := client.CommitAll(commitInfo)
done.Done(err)

fmt.Println("Commit successful! Commit hash: ", commitHash)

Amending the Latest Commit

To amend the latest commit (e.g., to modify the commit message or add more changes), use the AmendCommit method:

amendConfig := gogit.AmendConfig{
	//message
}

commitHash, err := client.AmendCommit(amendConfig)
done.Done(err)

fmt.Println("Amend successful! Commit hash: ", commitHash)

Other Features

gogit provides additional functionality such as retrieving commit hashes and logs. Feel free to explore the source code for more advanced features and extensions.

Function Overview

• New(root string) (*Client, error)
  Initializes and returns a new Client instance for interacting with the Git repository located at the specified path.

• AddAll() error
  Adds all changes (including deletions) to the Git index (staging area).

• Status() (git.Status, error)
  Returns the current status of the working tree.

• CommitAll(options CommitInfo) (string, error)
  Commits all changes with the provided CommitInfo for the commit's author and message.

• AmendCommit(options AmendConfig) (string, error)
  Amends the latest commit with the provided commit message or adds new changes. The commit is amended using the --amend flag.

Contributing

Contributions are welcome! If you'd like to help improve this project, please feel free to:

• Open an issue for bug reports or feature requests
• Submit a pull request with your improvements

License

MIT License - See the LICENSE file for more details.

Thank you

Give me stars. Thank you!!!