John Siu Blog

Tech - Business Tool, Personal Toys

MyGit - Bash git automation script

☰ Table of Content

Migrated all my ZSH git functions into a standalone bash script.

Who & Why

  • Creating repositories for same set of remote servers repeatedly
  • Setting up repositories on multiple machines repeatedly
  • Working with repositories that push to same set of git servers

Features

  • Info
    • debug
    • remote
    • group
  • Selector
    • -g/–group
    • -r/–remote
  • Git Base Commands
    • fetch
    • init
    • push
      • –master
      • –all
  • API Base Commands
    • repo/repository
      • –pri/–private
      • –pub/–public
      • del/delete
      • ls/list
        • –archive
      • new
      • vis/visibility
      • desc/description
      • topic/topics

Limitation

  • Strict option/argument order
  • Minimum command line error detection
  • Current supported git servers
    • gitea
    • github
    • gogs
  • API commands must be executed at root of repository

Usage

Configuration File

Following configuration will be used in all examples:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# This should be put in ~/.mygit.conf

# <remote name>

# MY_GIT[<remote name>.del]=""	# API token with delete scope. Mainly for Github.
# MY_GIT[<remote name>.grp]=""	# Group name of remote.
# MY_GIT[<remote name>.ssh]=""	# SSH hostname / SSH config host.
# MY_GIT[<remote name>.tok]=""	# API token.
# MY_GIT[<remote name>.uri]=""	# API URI.
# MY_GIT[<remote name>.usr]=""	# API username.
# MY_GIT[<remote name>.ven]=""	# Vendor: github|gites|gogs
# MY_GIT[<remote name>.pri]=""	# Private visibility: true|false. Default to true if not set.

MY_GIT[gh.del]="1234567890abcdef1234567890abcdef12345678"
MY_GIT[gh.grp]="external"
MY_GIT[gh.ssh]="git@github.com"
MY_GIT[gh.tok]="234567890abcdef1234567890abcdef123456789"
MY_GIT[gh.uri]="https://api.github.com"
MY_GIT[gh.usr]="username1"
MY_GIT[gh.ven]="github"
MY_GIT[gh.pri]="false"

MY_GIT[server2.grp]="internal"
MY_GIT[server2.ssh]="git@server2"
MY_GIT[server2.tok]="34567890abcdef1234567890abcdef1234567890"
MY_GIT[server2.uri]="https://server2/api/v1"
MY_GIT[server2.usr]="username2"
MY_GIT[server2.ven]="gitea"

MY_GIT[server3.grp]="internal"
MY_GIT[server3.ssh]="git@server3"
MY_GIT[server3.tok]="4567890abcdef1234567890abcdef1234567890a"
MY_GIT[server3.uri]="https://server3/api/v1"
MY_GIT[server3.usr]="username3"
MY_GIT[server3.ven]="gitea"

Testing

1
2
3
git clone https://github.com/J-Siu/mygit.git
cd mygit
cp mygit.conf ~/.mygit.conf

Example below can be tested inside mygit dir.

Debug

Use following to enable debug output:

1
export _DEBUG=1

Info

The remote and group command provide a quick way to see what is configured.

remote

To show all remotes configured:

1
mygit remote

Output:

1
2
3
gh (external)
server3 (internal)
server2 (internal)
group

To show all groups configured:

1
mygit group

Output:

1
external internal

Selector

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
1
2
mygit -g external <command>
mygit -g external -g internal <command>
-r/–remote
1
2
mygit -r gh <command>
mygit -r gh -r server3 <command>

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

1
mygit -g external -r server2 <command>

Git Base Commands

init, fetch, push are git base commands.

init

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.

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

Before mygit init:

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

mygit init without selector:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
$ 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)

mygit init with group internal:

1
2
3
4
5
6
7
8
$ 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)

mygit init with repository name:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
$ 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

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

1
mygit push
1
mygit -r gh push

mygit push support options --master and --all

–master

If --master is used, mygit push will push to upstream(-u) master branch.

1
mygit push --master
–all

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

1
mygit -r gh push --all
fetch

fetch will do git fetch base on -g/-r selector. If no group nor remote are specified, all configured remotes will be fetched in sequence.

1
mygit fetch
1
mygit -r gh fetch

API Base Commands

mygit repo <command> are API base command. With exception of mygit repo ls/list, all API commands must be ran at root of repository.

Remote Information

mygit repo without specifying additional command will retrieve repository information from remote server.

Visibility Flags

--pri, --private, --pub, --public are options for repo new and repo vis below.

new

mygit repo new will create repository on remote server.

By default repository will be created with private visibility. This can be override with MY_GIT[<remote name>.pri]="false" in configuration file ~/.mygit.conf on a per remote basis. Or override with --pri/--pub in command line.

1
mygit repo new
1
mygit repo new --pub
1
mygit -g internal repo new
vis/visibility

mygit repo vis will get visibility status from remote.

1
2
mygit repo vis
mygit -g external repo visibility

Use --pri/--pub to change visibility settings on remote server.

1
2
mygit repo vis --pub
mygit -g external repo vis --pri
del/delete

THERE IS NO CONFIRMATION FOR DELETION.

mygit repo del will delete repository from remote.

1
2
mygit repo del
mygit -g external repo delete
Github

Github token need delete_repo scope to delete repository through API. Either use a token with that scope in MY_GIT[<remote name>.tok] or a separate token and put it in MY_GIT[<remote name>.del].

desc/description

mygit repo desc will get description of remote repository.

1
2
mygit repo desc
mygit -g external repo desc

mygit repo desc "<description>" can update description of remote repository. Description needs to be in double quote.

1
2
mygit repo desc "<description>"
mygit -g external repo desc "<description>"
topic/topics

mygit repo topic will get topics of remote repository.

1
2
mygit repo topic
mygit -g external repo topic

mygit repo topic "topics ..." can update topics of remote repository. Multiple topics needs to be in double quote.

1
2
mygit repo topic "topic1 topic2 topic3"
mygit -g external repo topic "topic1 topic2 topic3"
ls/list

mygit repo ls will list up to 100 repositories on remote server. This command does not depend on repository.

By default archived repositories are filtered out. Use --archive to show them also.

1
2
3
4
mygit repo ls
mygit repo ls --archive
mygit -g internal repo ls
mygit -r gh repo ls

New Repository Workflow

Assuming ~/.mygit.conf is setup.

1
2
3
mygit init
mygit repo new
mygit push --master

Repository

Contributors

Change Log

  • 0.1.0
    • Feature complete
  • 0.2.0
    • README.md completed
    • add -g/-r checking
    • add init repository name support
    • add repo get info
    • add repo ls –archive flag
    • add usage
    • change push master/all to flag(–)
    • fix comment typo
    • fix repo del github del token logic
    • fix repo ls gogs/gitea support
    • fix repo new visibility logic
    • move desc, topic into repo

License

The MIT License (MIT)

Copyright (c) 2020 John Siu

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.

John Siu

Update: 2020-08-12
Tag
[git]
[cli]
[lib]
comments powered by Disqus