minor doc updates

This commit is contained in:
vilmibm 2020-01-28 10:20:19 -06:00
parent d753f7e5b7
commit f2b6f4b802
2 changed files with 16 additions and 10 deletions

View file

@ -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

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/`