Skip to content

Instantly share code, notes, and snippets.

@chenasraf

chenasraf/_README.md

Last active August 12, 2024 18:10
Show Gist options
  • Save chenasraf/03d65bade44d638753731a07286beadf to your computer and use it in GitHub Desktop.
Save chenasraf/03d65bade44d638753731a07286beadf to your computer and use it in GitHub Desktop.
Download ZIP
Git Open URLs Aliases
Raw
_README.md

Update: Created as a repo for easy install, see chenasraf/git-open

What does this do?

Creates git aliases to open git URLs for project, new PR, PR list and CI-CD/Actions.

Usage

Usage: git open <command>
Commands:
  project|repo|open|.       Open the project
  branch                    Open the project at given (or current) branch
  commit                    Open the project at given (or current) commit
  file                      Open the project at given file. Can also append ref hash
  prs                       Open the PR list
  pr                        Open a new PR
  actions|pipelines|ci      Open the CI/CD pipelines

Requirements

  • Written as zsh files, but should work in bash/other shells or easily converted if not.
  • Git
  • macOS/Linux

How to install

  1. Put the git_custom_commands file anywhere
  2. Run the aliases.zsh script to set the aliases globally. Omit any you don't want. git open acts as a generic call. Don't forget to update the path to the
  3. Enjoy. Use git open without args to get the help message if you forget the parameters.
Raw
aliases.zsh
# Open
git config --global alias.open "!/path/to/git_custom_commands.plugin.zsh open"
git config --global alias.project "open project"
git config --global alias.pr "open pr"
git config --global alias.prs "open prs"
git config --global alias.ci "open ci"
# List aliases
git config --global alias.list-aliases "!git config --global --list | grep --color alias\. | grep -v list-aliases | sed \"s/alias\./\$(tput setaf 1)/\" | sed \"s/=/\$(tput sgr0)=/\""
Raw
git_custom_commands.zsh
#!/usr/bin/env zsh
uriencode() {
len="${#1}"
for ((n = 0; n < len; n++)); do
c="${1:$n:1}"
case $c in
[a-zA-Z0-9.~_-]) printf "$c" ;;
*) printf '%%%02X' "'$c"
esac
done
}
git_get_remote() {
remote=$(git remote -v | grep "(push)" | awk '{print $2}')
echo $remote
}
git_get_repo_path() {
remote=$1
repo_path=''
if [[ $remote =~ ^git@ ]]; then
repo_path=$(echo "$remote" | sed -E 's/^git@[^:]+:([^:]+)\.git$/\1/')
elif [[ $remote =~ ^https?:// ]]; then
repo_path=$(echo "$remote" | sed -E 's|^https?://[^/]+/([^\.]+)\.git$|\1|')
fi
echo $repo_path
}
open_url() {
echo "Opening $1"
is_mac=$(uname | grep -i darwin)
is_linux=$(uname | grep -i linux)
if [[ ! -z $is_mac ]]; then
open $1
elif [[ ! -z $is_linux ]]; then
xdg-open $1
fi
}
git_get_remote_type() {
remote=$1
repo_path=$(git_get_repo_path $remote)
remote_type='github'
case $remote in
*github.com*)
remote_type='github'
;;
*gitlab.com*)
remote_type='gitlab'
;;
*bitbucket.org*)
remote_type='bitbucket'
;;
*)
return 1
;;
esac
echo $remote_type
return 0
}
git_open_project() {
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
repo_path=$(git_get_repo_path $remote)
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
case $remote_type in
github)
open_url "https://github.com/$repo_path"
;;
gitlab)
open_url "https://gitlab.com/$repo_path"
;;
bitbucket)
open_url "https://bitbucket.org/$repo_path"
;;
*)
echo "Unknown remote type: $remote_type"
return 2
;;
esac
return 0
}
git_open_branch() {
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
repo_path=$(git_get_repo_path $remote)
branch=$([[ ! -z $2 ]] && echo "$2" || git branch --show-current)
case $remote_type in
github)
open_url "https://github.com/$repo_path/tree/$branch"
;;
gitlab)
open_url "https://gitlab.com/$repo_path/-/tree/$branch"
;;
bitbucket)
open_url "https://bitbucket.org/$repo_path/branch/$branch"
;;
esac
return 0
}
git_open_file() {
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
repo_path=$(git_get_repo_path $remote)
file=$([[ ! -z $2 ]] && echo "$2" || echo "")
branch=$([[ ! -z $3 ]] && echo "$3" || git branch --show-current)
case $remote_type in
github)
open_url "https://github.com/$repo_path/blob/$branch/$file"
;;
gitlab)
open_url "https://gitlab.com/$repo_path/-/blob/$branch/$file"
;;
bitbucket)
open_url "https://bitbucket.org/$repo_path/src/$file"
;;
esac
return 0
}
git_open_commit() {
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
repo_path=$(git_get_repo_path $remote)
commit=$([[ ! -z $2 ]] && echo "$2" || git rev-parse HEAD)
case $remote_type in
github)
open_url "https://github.com/$repo_path/commit/$commit"
;;
gitlab)
open_url "https://gitlab.com/$repo_path/-/commit/$commit"
;;
bitbucket)
open_url "https://bitbucket.org/$repo_path/commit/$commit"
;;
esac
return 0
}
git_open_pr_list() {
# branch=$1
# if [[ -z $branch ]]; then
# branch=$(git branch --show-current)
# fi
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
repo_path=$(git_get_repo_path $remote)
case $remote_type in
github)
# open_url "https://github.com/$repo_path/pulls?q=is%3Apr+is%3Aopen+head%3A$branch"
open_url "https://github.com/$repo_path/pulls?q=is%3Apr+is%3Aopen"
;;
gitlab)
# open_url "https://gitlab.com/$repo_path/merge_requests?scope=all&state=opened&search=$branch"
open_url "https://gitlab.com/$repo_path/merge_requests?scope=all&state=opened"
;;
bitbucket)
# open_url "https://bitbucket.org/$repo_path/pull-requests?state=OPEN&source=$branch"
open_url "https://bitbucket.org/$repo_path/pull-requests?state=OPEN"
;;
*)
echo "Unknown remote type: $remote_type"
return 2
;;
esac
return 0
}
git_open_new_pr() {
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
repo_path=$(git_get_repo_path $remote)
branch=$([[ ! -z $1 ]] && echo "$1" || git branch --show-current)
default_branch=$(git remote show $remote | grep "HEAD branch" | awk '{print $3}')
if [[ -z $default_branch ]]; then
default_branch="master"
fi
branch=$(uriencode $branch)
default_branch=$(uriencode $default_branch)
case $remote_type in
github)
open_url "https://github.com/$repo_path/compare/$branch...$default_branch"
;;
gitlab)
open_url "https://gitlab.com/$repo_path/-/merge_requests/new?merge_request%5Bsource_branch%5D=$branch&merge_request%5Btarget_branch%5D=$default_branch"
;;
bitbucket)
open_url "https://bitbucket.org/$repo_path/pull-requests/new?source=$branch&t=1"
;;
esac
return 0
}
git_open_pipelines() {
branch=$1
if [[ -z $branch ]]; then
branch=$(git branch --show-current)
fi
remote=$(git_get_remote)
if [[ -z $remote ]]; then
echo "No remote found"
return 1
fi
remote_type=$(git_get_remote_type $remote)
if [[ -z $remote_type ]]; then
echo "Unknown remote type for $remote"
return 1
fi
repo_path=$(git_get_repo_path $remote)
case $remote_type in
github)
# open_url "https://github.com/$repo_path/actions?query=branch%3A$branch"
open_url "https://github.com/$repo_path/actions"
;;
gitlab)
# open_url "https://gitlab.com/$repo_path/pipelines?scope=all&ref=$branch"
open_url "https://gitlab.com/$repo_path/pipelines?scope=all"
;;
bitbucket)
# open_url "https://bitbucket.org/$repo_path/addon/pipelines/home#!/results/$branch"
open_url "https://bitbucket.org/$repo_path/addon/pipelines/home"
;;
esac
return 0
}
git_open() {
if [[ -z $1 ]]; then
echo "Usage: git open <command>"
echo "Commands:"
echo " project|repo|open|. Open the project"
echo " branch Open the project at given (or current) branch"
echo " commit Open the project at given (or current) commit"
echo " file Open the project at given file. Can also append ref hash"
echo " prs Open the PR list"
echo " pr Open a new PR"
echo " actions|pipelines|ci Open the CI/CD pipelines"
return 1
fi
case $1 in
project|repo|\.)
git_open_project
;;
branch)
git_open_branch $@
;;
file)
git_open_file $@
;;
commit)
git_open_commit $@
;;
prs)
shift
git_open_pr_list
;;
pr)
shift
git_open_new_pr $@
;;
actions|pipelines|ci)
shift
git_open_pipelines
;;
_debug)
inf="Getting info"
y=$(tput setaf 3)
g=$(tput setaf 2)
r=$(tput sgr0)
echo -n "$r- ${y}$inf\r"
remote=$(git_get_remote)
echo -n "$r\\ ${y}$inf.\r"
info=$(git remote show $remote)
echo -n "$r| ${y}$inf..\r"
branch=$(git branch --show-current)
echo -n "$r/ ${y}$inf...\r"
commit=$(git rev-parse HEAD)
echo "${g}Done\e[0K$r\n"
echo "Remote: $remote"
echo "Repo Path: $(git_get_repo_path $remote)"
echo "Remote Type: $(git_get_remote_type $remote)"
echo "Branch: $branch"
echo "Default Branch: $(echo $info | grep "HEAD branch" | awk '{print $3}')"
echo "Commit: $commit"
;;
*)
echo "Unknown command: $1"
return 1
;;
esac
}
case $1 in
open)
shift
git_open $@
;;
esac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment