Skip to content

Latest commit

 

History

History
386 lines (296 loc) · 9.92 KB

README.md

File metadata and controls

386 lines (296 loc) · 9.92 KB
Raw

go-MyGit Paypal donate

Command line tool for easy mass configuration of git remotes, and working with Github/Gites repositories API.

Table Of Content

This replaces mygit, implemented in Bash.

Highlight

Following are highlight of some go-mygit functions.

Push multiple repository

# Push to all remotes
go-mygit push
# Support path operation
go-mygit push docker_*

Set Archived

# Set archived to true
go-mygit repo set archived true
# Set archived to false
go-mygit repo set archived false

Set Private

# Set current repository to private on server
go-mygit repo set private true
# Support path operation
go-mygit repo set private false docker_*

Update Description

# Update description on server of current repository/directory
go-mygit repo set description "This is a new description"

Update Topics

# Update topics on server of current repository/directory
go-mygit repo set topic golang go project

What It Does

These are the reasons "mygit" got created.

  • Parallel processing multiple repository, eg. pushing 10 repos at the same time
  • Pushing same repo to multiple git servers which are not mirrored
  • Set up same set of git remote repeatedly
  • Update repository info on git server(api)

What It Does Not

  • Replace git command. (git command is required for git function to work.)
  • Replace Github cli gh (go-mygit only cover very few api in comparison.)

Features

  • Configuration File
    • remotes
    • groups
    • secrets
  • Selector for git servers
    • -g/--group
    • -r/--remote
  • Base(git) Commands
    • clone
    • init
    • pull
    • push
    • remote
      • add
      • list
      • remove
  • Repository(api)
    • list all repo on server
    • create repo on server
    • get / set
      • archived
      • description
      • private
      • public key(get only)
      • secret
      • topic
      • visibility
    • delete
      • repository
      • secret

Limitation

  • Current supported git servers
    • github
    • gitea
    • gogs(not tested)

Go Install

go install github.com/J-Siu/go-mygit/v2@latest

Usage

Git and Repo automation made easy.

Usage:
  go-mygit [command]

Available Commands:
  clone       Git clone
  completion  Generate the autocompletion script for the specified shell
  config      Print configurations
  help        Help about any command
  init        Git init and reset remotes
  pull        Git pull
  push        Git push
  remote      Git remote commands
  repository  Repository commands

Flags:
      --config string        config file (default is $HOME/.go-mygit.json)
  -d, --debug                Enable debug
  -g, --group stringArray    Specify group
  -h, --help                 help for go-mygit
      --no-parallel          Don't process in parallel
      --no-skip              Don't skip empty output
      --no-title             Don't print title for most output
  -r, --remote stringArray   Specify remotes

Use "go-mygit [command] --help" for more information about a command.

Debug

Use -d for debug output.

Example:

go-mygit -d repo des get

Selector

go-mygit allow command applied to groups or remotes through the use of -g/--group and -r/--remote. This applies to all commands except remote and group mentioned above.

-g/--group and -r/--remote must be placed right after mygit and before any command.

-g/--group
go-mygit -g external <command>
go-mygit -g external -g internal <command>
-r/--remote
go-mygit -r gh <command>
go-mygit -r gh -r server3 <command>

-g/--group and -r/--remote can be used at the same time.

go-mygit -g external -r server2 <command>

Git Base Commands

init, push are git base commands.

init

go-mygit init will clear all existing remote and add remote base on -g/-r selector. If no group nor remote are specified, all configured remotes will be added.

go-mygit init by default use current directory name as repository name. Repository name can be specified in the format go-mygit init <repository>. File .go-mygit.json containing the repository name will be created, which is used by API based commands.

Before go-mygit init:

$ git remote -v
origin  https://github.com/J-Siu/mygit.git (fetch)
origin  https://github.com/J-Siu/mygit.git (push)

go-mygit init without selector:

$ go-mygit init
Reinitialized existing Git repository in /tmp/mygit/.git/

$ git remote -v
gh      git@github.com:/username1/mygit.git (fetch)
gh      git@github.com:/username1/mygit.git (push)
server2 git@server2:/username2/mygit.git (fetch)
server2 git@server2:/username2/mygit.git (push)
server3 git@server3:/username3/mygit.git (fetch)
server3 git@server3:/username3/mygit.git (push)

go-mygit init with group internal:

$ go-mygit --group internal init
Reinitialized existing Git repository in /tmp/mygit/.git/

$ git remote -v
server2 git@server2:/username2/mygit.git (fetch)
server2 git@server2:/username2/mygit.git (push)
server3 git@server3:/username3/mygit.git (fetch)
server3 git@server3:/username3/mygit.git (push)

go-mygit init with repository name:

$ go-mygit init mygit2
Reinitialized existing Git repository in /tmp/mygit/.git/

$ git remote -v
gh      git@github.com:/username1/mygit2.git (fetch)
gh      git@github.com:/username1/mygit2.git (push)
server2 git@server2:/username2/mygit2.git (fetch)
server2 git@server2:/username2/mygit2.git (push)
server3 git@server3:/username3/mygit2.git (fetch)
server3 git@server3:/username3/mygit2.git (push)
push

go-mygit push base on -g/-r selector. If no group nor remote are specified, all configured remotes will be pushed in sequence.

go-mygit push
go-mygit -r gh push

go-mygit push support options --tags and --all

--tags

If --tags is used, go-mygit push will push all tags.

go-mygit push --tags
--all

If --all is used, mygit push will push all branches(--all).

go-mygit -r gh push --all

Configuration

See go-mygit.json.md

Packages Used

Binary

https://github.com/J-Siu/go-mygit/releases

Repository

Contributors

Change Log

  • v1.0.0
    • Feature complete
  • v1.0.1
    • Fix repo new endpoint
  • v2.0.0
    • Command line restructure
    • Clean up func name
    • Clean up file name
    • Fix typos
  • v2.0.1
    • upgrade go-helper and go-gitapi for bugfix
  • v2.1.0
    • Add repo name support for all repoGet* commands
  • v2.2.0
    • Support deletion of github repository action secret
  • v2.3.0
    • Add repo(dir) name support for init, push, repo new, and all remote* commands
  • v2.4.0
    • Add global --noskip flag
    • Improve commands Use, Short, Long
    • Improve repo/dir handling from command line
    • lib.GitApiFromRemote() -> Remote.GetGitApi()
  • v2.4.1
    • Fix goreleaser
  • v2.4.2
    • Proper go mod path for v2
  • v2.5.0
    • Add global flag
      • --no-parallel, don't process in parallel
      • --no-title, don't print title in output
    • Add support for handling archived status
    • Fix exiting on non-git directory
    • Fix remote listing not work for current directory
    • Fix push to use git directory remotes
  • v2.5.1
    • Remove Go workspace file
  • v2.6.0
    • Detect if no configuration file
    • Add git clone
    • Add git pull
  • v2.7.0
    • upgrade go-helper to v1.1.6
    • upgrade go-gitapi to v1.4.0
    • Add "skipverify" in "remotes" config
      • support site with self-signed cert

License

The MIT License (MIT)

Copyright © 2023 John, Sing Dao, Siu john.sd.siu@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.