Skip to content

Commit

Permalink
minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
vilmibm committed Jan 28, 2020
1 parent d753f7e commit f2b6f4b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
22 changes: 14 additions & 8 deletions releasing.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
# Releasing

## How to test locally
## Test Locally

`go test ./...`

## How to create a release
## Push new docs

This can all be done from your local terminal.
build docs locally: `make site`

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/cli/cli/actions) to check the progress.
4. Go to <https://github.com/cli/cli/releases> and look at the release
build and push docs to production: `make site-docs`

## How to test a release
## 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.

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/cli/cli/actions) to check the progress.
4. Go to <https://github.com/cli/cli/releases> and look at the release

0 comments on commit f2b6f4b

Please sign in to comment.