STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #261 from cli/docs

Browse source 
minor doc updates
This commit is contained in:
Nate Smith 2020-01-28 11:06:36 -06:00 • committed by GitHub
commit 1f86bf0456
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -3,7 +3,7 @@
`gh` is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to
the terminal next to where you are already working with `git` and your code.
![screenshot](https://user-images.githubusercontent.com/98482/73207890-1b7f6180-410b-11ea-9c75-d20c436eba71.png)
![screenshot](https://user-images.githubusercontent.com/98482/73286699-9f922180-41bd-11ea-87c9-60a2d31fd0ac.png)
## Usage
@ -47,6 +47,6 @@ MSI installers are available on the [releases page][].
There are prebuilt binaries available on the [releases page][].
[docs]: https://cli.github.com/manual
[docs]: https://cli.github.io/cli/gh <!-- TODO eventually we'll have https://cli.github.com/manual -->
[releases page]: https://github.com/cli/cli/releases/latest
[hub]: https://github.com/github/hub

24
releasing.md
View file

@ -1,10 +1,23 @@
# Releasing
## How to test locally
## Test Locally
`go test ./...`
## How to create a release
## Push new docs
build docs locally: `make site`
build and push docs to production: `make site-docs`
## Release locally for debugging
A local release can be created for testing without creating anything official on the release page.
1. `env GH_OAUTH_CLIENT_SECRET= GH_OAUTH_CLIENT_ID= goreleaser --skip-validate --skip-publish --rm-dist`
2. Check and test files in `dist/`
## Release to production
This can all be done from your local terminal.
@ -12,10 +25,3 @@ This can all be done from your local terminal.
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/cli/cli/actions) to check the progress.
4. Go to <https://github.com/cli/cli/releases> and look at the release
## How to test a release
A local release can be created for testing without creating anything official on the release page.
1. `env GH_OAUTH_CLIENT_SECRET= GH_OAUTH_CLIENT_ID= goreleaser --skip-validate --skip-publish --rm-dist`
2. Check and test files in `dist/`