Skip to content

Commit 23c7eeb

Browse files
committed
add linux instructions and test release instructions to readme
1 parent 9c45965 commit 23c7eeb

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,27 @@ This tool is an endeavor separate from [github/hub](https://github.com/github/hu
88

99
_warning, gh is in a very alpha phase_
1010

11+
## OSX
12+
1113
`brew install github/gh/gh`
1214

13-
That's it. You are now ready to use `gh` on the command line. 🥳
15+
## Debian/Ubuntu Linux
16+
17+
1. Download the latest `.deb` file from the [releases page](https://github.com/github/gh-cli/releases)
18+
2. Install it with `sudo dpkg -i gh_0.2.2_linux_amd64.deb`, changing version number accordingly
19+
20+
_(Uninstall with `sudo apt remove gh`)_
21+
22+
## Fedora/Centos Linux
23+
24+
1. Download the latest `.rpm` file from the [releases page](https://github.com/github/gh-cli/releases)
25+
2. Install it with `sudo rpm -ivh gh_0.2.2_linux_amd64.rpm`, changing version number accordingly
26+
27+
## Other Linux
28+
29+
1. Download the latest `_linux_amd64.tar.gz` file from the [releases page](https://github.com/github/gh-cli/releases)
30+
2. `tar -xvf gh_0.2.2_linux_amd64.tar.gz`, changing version number accordingly
31+
3. Copy the uncompressed `gh` somewhere on your `$PATH` (e.g. `sudo cp gh /usr/local/bin/`)
1432

1533
# Process
1634

@@ -25,4 +43,13 @@ This can all be done from your local terminal.
2543
1. `git tag 'vVERSION_NUMBER' # example git tag 'v0.0.1'`
2644
2. `git push origin vVERSION_NUMBER`
2745
3. Wait a few minutes for the build to run and CI to pass. Look at the [actions tab](https://github.com/github/gh-cli/actions) to check the progress.
28-
4. Go to https://github.com/github/homebrew-gh/releases and look at the release
46+
4. Go to <https://github.com/github/homebrew-gh/releases> and look at the release
47+
48+
# Test a release
49+
50+
A local release can be created for testing without creating anything official on the release page.
51+
52+
1. `git tag 'v6.6.6' # some throwaway version number`
53+
2. `env GH_OAUTH_CLIENT_SECRET=foobar GH_OAUTH_CLIENT_ID=1234 goreleaser --skip-publish --rm-dist`
54+
3. Check and test files in `dist/`
55+
4. `git tag -d v6.6.6 # delete the throwaway tag`

0 commit comments

Comments
 (0)