STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
load test
526 commits 87 branches 0 tags 160 MiB
Find a file
Nate Smith 83c647366b Merge pull request #213 from github/git-current-branch-compat 
Read current git branch in a way that is compatible with older git
2020-01-10 16:06:27 -06:00
.github Add npm run build script to download-exe action 2020-01-09 15:04:34 +01:00
.vscode Add VS Code settings 2019-10-07 16:36:23 +02:00
api Make it work with PRs 2020-01-08 11:44:27 -08:00
auth Fix opening OAuth URL in browser 2019-11-27 14:08:42 +01:00
cmd/gen-docs Generate help docs to GitHub Pages 2019-11-28 16:43:07 +01:00
command Make it work with PRs 2020-01-08 12:31:23 -08:00
context Merge pull request #168 from github/goodbye-migration 2019-12-19 15:19:01 -06:00
git Read current git branch in a way that is compatible with older git 2020-01-10 14:08:54 +01:00
pkg/githubtemplate Replace goto with break <label> 2019-12-20 15:05:37 +01:00
script Merge pull request #201 from github/cleanup-scripts 2020-01-08 17:22:46 +01:00
test Fix fixtures 2020-01-08 12:40:39 -08:00
update Simplify case when state.yml is non-existent or corrupt 2019-12-13 17:04:07 +01:00
utils Add docs to color funcs 2019-11-28 11:55:14 +01:00
.gitattributes Instruct Linguist to exclude files under .github/ from language stats 2020-01-07 15:22:43 +01:00
.gitignore Generate changelog on release 2020-01-07 13:55:56 +01:00
.goreleaser.yml Generate changelog on release 2020-01-07 13:55:56 +01:00
go.mod Update go.mod 2019-12-04 10:47:44 -08:00
go.sum Merge pull request #127 from github/help-site 2019-12-05 18:37:46 +01:00
LICENSE Create LICENSE 2019-11-21 13:22:23 -06:00
main.go Have one place manage the config dir location 2019-12-13 16:16:46 -08:00
Makefile Improve site-docs make task 2019-12-16 15:59:46 +01:00
README.md Update README.md 2019-11-27 10:47:35 -06:00
wix.json automatically produce MSI files for releases 2019-12-19 15:03:03 -06:00

README.md

gh - The GitHub CLI tool

The #ce-cli team is working on a publicly available CLI tool to reduce the friction between GitHub and one's local machine for people who use the command line primarily to interact with Git and GitHub. https://github.com/github/releases/issues/659

This tool is an endeavor separate from github/hub, which acts as a proxy to git, since our aim is to reimagine from scratch the kind of command line interface to GitHub that would serve our users' interests best.

Installation

warning, gh is in a very alpha phase

macOS

brew install github/gh/gh

Debian/Ubuntu Linux

  1. sudo apt install git if you don't already have git
  2. Download the .deb file from the releases page
  3. sudo dpkg -i gh_*_linux_amd64.deb install the downloaded file

(Uninstall with sudo apt remove gh)

Fedora/Centos Linux

  1. Download the .rpm file from the releases page
  2. sudo yum localinstall gh_*_linux_amd64.rpm install the downloaded file

(Uninstall with sudo yum remove gh)

Other Linux

  1. Download the _linux_amd64.tar.gz file from the releases page
  2. tar -xf gh_*_linux_amd64.tar.gz
  3. Copy the uncompressed gh somewhere on your $PATH (e.g. sudo cp gh_*_linux_amd64/bin/gh /usr/local/bin/)

(Uninstall with rm)

Process

How to create a release

This can all be done from your local terminal.

  1. git tag 'vVERSION_NUMBER' # example git tag 'v0.0.1'
  2. git push origin vVERSION_NUMBER
  3. Wait a few minutes for the build to run and CI to pass. Look at the actions tab to check the progress.
  4. Go to https://github.com/github/homebrew-gh/releases and look at the release

Test a release

A local release can be created for testing without creating anything official on the release page.

  1. git tag 'v6.6.6' # some throwaway version number
  2. env GH_OAUTH_CLIENT_SECRET=foobar GH_OAUTH_CLIENT_ID=1234 goreleaser --skip-publish --rm-dist
  3. Check and test files in dist/
  4. git tag -d v6.6.6 # delete the throwaway tag