From f2b6f4b80231eaceceda66526a76d8e19c922d72 Mon Sep 17 00:00:00 2001 From: vilmibm Date: Tue, 28 Jan 2020 10:20:19 -0600 Subject: [PATCH 1/3] minor doc updates --- README.md | 2 +- releasing.md | 24 +++++++++++++++--------- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d07c5f049..ba6562c1c 100644 --- a/README.md +++ b/README.md @@ -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 [releases page]: https://github.com/cli/cli/releases/latest [hub]: https://github.com/github/hub diff --git a/releasing.md b/releasing.md index e590c3eeb..00646a18a 100644 --- a/releasing.md +++ b/releasing.md @@ -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 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/` From c5a79e36da78d3b45fc037e367f59ccc046b5eb6 Mon Sep 17 00:00:00 2001 From: vilmibm Date: Tue, 28 Jan 2020 10:43:04 -0600 Subject: [PATCH 2/3] nicer screenshot --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba6562c1c..ad492a0da 100644 --- a/README.md +++ b/README.md @@ -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/73284889-d6b30380-41ba-11ea-807d-2667f89cc89b.png) ## Usage From 9133ddb236e2e310881675d5305cc0e922055554 Mon Sep 17 00:00:00 2001 From: Nate Smith Date: Tue, 28 Jan 2020 11:02:44 -0600 Subject: [PATCH 3/3] more pixels --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ad492a0da..839bbe5a4 100644 --- a/README.md +++ b/README.md @@ -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/73284889-d6b30380-41ba-11ea-807d-2667f89cc89b.png) +![screenshot](https://user-images.githubusercontent.com/98482/73286699-9f922180-41bd-11ea-87c9-60a2d31fd0ac.png) ## Usage