cli/docs/releasing.md
Billy Griffin f32235aa08 Move docs to docs folder
The docs were just hanging out in the top level repo and we thought it'd be nicer to start to organize them together.
2020-03-10 12:52:01 -06:00

810 B

Releasing

Test Locally

go test ./...

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.

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