Merge pull request cli#102 from github/linux-packages

Nate Smith · web-flow · commit 39a5dbc2f27e · 2019-11-26T10:24:16.000-06:00
linux packaging
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -24,6 +24,18 @@ archives:
     format_overrides:
       - goos: windows
         format: zip
+
+nfpms:
+  - license: MIT
+    maintainer: GitHub
+    homepage: https://github.com/github/gh-cli
+    bindir: /usr/local
+    dependencies:
+      - git
+    formats:
+      - deb
+      - rpm
+
 changelog:
   sort: asc
   filters:
diff --git a/README.md b/README.md
@@ -8,9 +8,31 @@ This tool is an endeavor separate from [github/hub](https://github.com/github/hu
 
 _warning, gh is in a very alpha phase_
 
+## macOS
+
 `brew install github/gh/gh`
 
-That's it. You are now ready to use `gh` on the command line. 🥳
+## Debian/Ubuntu Linux
+
+1. Download the latest `.deb` file from the [releases page](https://github.com/github/gh-cli/releases)
+2. Install it with `sudo dpkg -i gh_0.2.2_linux_amd64.deb`, changing version number accordingly
+
+_(Uninstall with `sudo apt remove gh`)_
+
+## Fedora/Centos Linux
+
+1. Download the latest `.rpm` file from the [releases page](https://github.com/github/gh-cli/releases)
+2. Install it with `sudo yum localinstall gh_0.2.2_linux_amd64.rpm`, changing version number accordingly
+
+_(Uninstall with `sudo yum remove gh`)_
+
+## Other Linux
+
+1. Download the latest `_linux_amd64.tar.gz` file from the [releases page](https://github.com/github/gh-cli/releases)
+2. `tar -xvf gh_0.2.2_linux_amd64.tar.gz`, changing version number accordingly
+3. Copy the uncompressed `gh` somewhere on your `$PATH` (e.g. `sudo cp gh /usr/local/bin/`)
+
+_(Uninstall with `rm`)_
 
 # Process
 
@@ -25,4 +47,13 @@ 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](https://github.com/github/gh-cli/actions) to check the progress.
-4. Go to https://github.com/github/homebrew-gh/releases and look at the release
+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`
