-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release doc #44
Merged
Merged
Release doc #44
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Release | ||
|
||
## Before You Begin | ||
|
||
Ensure your local workstation is configured to be able to | ||
[Sign commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). | ||
|
||
## Local Release Preparation | ||
|
||
### Checkout latest code | ||
|
||
```shell | ||
$ git checkout master | ||
$ git pull origin master | ||
``` | ||
|
||
### Bump version | ||
|
||
Update version in [`lib/toxiproxy/version.rb`](./lib/toxiproxy/version.rb). | ||
Check if there is required changes in [`README.md`](./README.md). | ||
|
||
### Run Tests | ||
|
||
Make sure all tests passed and gem could be build | ||
|
||
```shell | ||
$ rake test | ||
$ rake build | ||
``` | ||
|
||
### Create Release Commit and Tag | ||
|
||
Commit changes and create a tag. Make sure commit and tag are signed. | ||
|
||
```shell | ||
$ export RELEASE_VERSION=2.x.y | ||
$ git commit -a -S -m "Release $RELEASE_VERSION" | ||
$ git tag -s "v$RELEASE_VERSION" | ||
``` | ||
|
||
## Release Tag | ||
|
||
On your local machine again, push your tag to the repository. | ||
|
||
```shell | ||
$ git push origin "v$RELEASE_VERSION" | ||
``` | ||
|
||
and only after push changes in `master`: | ||
|
||
```shell | ||
$ git push origin master | ||
``` | ||
|
||
## Verify rubygems release | ||
|
||
- Shipit should kick off a build and release after new version detected. | ||
- Check [rubygems](https://rubygems.org/gems/toxiproxy) | ||
|
||
## Github release | ||
|
||
- Create a new gem | ||
```shell | ||
$ bundle exec rake build | ||
``` | ||
- Create github release. Choose either `hub` or `gh`. | ||
* Github CLi [gh_release_create](https://cli.github.com/manual/gh_release_create) : | ||
``` | ||
$ gh release create v<version> pkg/toxiproxy-<version>.gem | ||
``` | ||
* Hub: | ||
``` | ||
$ hub release create -a pkg/toxiproxy-<version>.gem v<version> | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super minor, but I am not a fan of including
$
in command output unless we need to distinguish between typed commands and output being presented to the user.Advantage of not including the
$
is that it makes it easier for people to copy pasta the actual command they need (there's a handy "copy this text" button on Github Markdown boxes) without having to manually remove the preceding$
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that exactly the reason why I am adding $. to force people to think before copy paste. It has extra visability - show that it is command line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ideally github should add it automatically for shell code lines. and have empty lines as separation, but it is not supported for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok. Aleem on my side :P