forked from cli/cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
15 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |