Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: better pub. doc. & rake count
- Loading branch information
Showing
3 changed files
with
39 additions
and
13 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
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,39 +1,58 @@ | ||
# Publishing | ||
|
||
## On Rubygems.org | ||
Be sure all tests pass! | ||
|
||
``` | ||
$ git tag -a vx.x.x | ||
$ git push --follow-tags | ||
$ gem push haiti-hash-x.x.x.gem | ||
$ bundle exec rake test | ||
``` | ||
|
||
Also check the linter: | ||
|
||
``` | ||
$ bundle exec rubocop | ||
``` | ||
|
||
See https://guides.rubygems.org/publishing/. | ||
Count the number of hash type supported: | ||
|
||
``` | ||
$ bundle exec rake count | ||
``` | ||
|
||
Update the number in the following files: | ||
|
||
- `README.md` | ||
- `docs/_coverpage.md` | ||
- `docs/README.md` | ||
- `docs/why.md` | ||
|
||
On new release don't forget to rebuild the library documentation: | ||
|
||
``` | ||
$ bundle exec yard doc | ||
``` | ||
|
||
An to be sure all tests pass! | ||
Create an annotated git tag: | ||
|
||
``` | ||
$ rake | ||
$ git tag -a vx.x.x | ||
``` | ||
|
||
## On BlackArch | ||
Push the changes including the tags: | ||
|
||
BA process | ||
``` | ||
$ git push --follow-tags | ||
``` | ||
|
||
On new release don't forget to rebuild the library documentation: | ||
Build the gem: | ||
|
||
``` | ||
$ bundle exec yard doc | ||
$ gem build haiti.gemspec | ||
# or | ||
$ bundle exec rake build | ||
``` | ||
|
||
An to be sure all tests pass! | ||
Push the new gem release on RubyGems See https://guides.rubygems.org/publishing/. | ||
|
||
``` | ||
$ rake | ||
$ gem push haiti-hash-x.x.x.gem | ||
``` |