Skip to content

Commit

Permalink
chore: better pub. doc. & rake count
Browse files Browse the repository at this point in the history
  • Loading branch information
noraj committed Dec 15, 2021
1 parent 8929d2d commit 2c69f2a
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 13 deletions.
5 changes: 5 additions & 0 deletions Rakefile
Expand Up @@ -9,3 +9,8 @@ end

desc 'Run tests'
task default: :test

desc 'Count the number of hash types'
task :count do
puts File.read('data/prototypes.json').scan(/"extended"/).count
end
2 changes: 2 additions & 0 deletions docs/CHANGELOG.md
Expand Up @@ -13,6 +13,8 @@
- VirtualBox (PBKDF2-HMAC-SHA256 & AES-256-XTS) [#89][#89]
- Chore:
- MFA required for gem release
- Better publishing documentation
- Add a rake task to count the number of hash types supported
- Dependencies:
- Update to yard [v0.9.27](https://github.com/lsegal/yard/releases/tag/v0.9.27)
- Move from Redcarpet to CommonMarker markdown provider
Expand Down
45 changes: 32 additions & 13 deletions docs/pages/publishing.md
@@ -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
```

0 comments on commit 2c69f2a

Please sign in to comment.