Skip to content

Commit

Permalink
Adding guidance on determining Semantic Versioning
Browse files Browse the repository at this point in the history
In looking further at `yard diff`, I discovered that you can compare
the generated `.yardoc` directory (or directories) against a built
gem.

The two gem version parameters can each either be a named gem version
OR a path to a generated `.yardoc`

See https://github.com/lsegal/yard/blob/8e82a8ab27f2e711bf555bb6ba0c037a1eb3ccfb/spec/cli/diff_spec.rb#L178-L179
for specs
  • Loading branch information
jeremyf committed Mar 2, 2020
1 parent ea90e78 commit e28c94a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ Below is the checklist:
- [ ] Pull down the latest version of master
- [ ] Update the Huborg::VERSION (in ./lib/huborg/version.rb); Remember, huborg
uses [Semantic Versioning](https://semver.org). (_**NOTE:** Do not commit the version change_)
- [ ] To give some insight on what version to use, you can use `yard diff`. With a clean master branch, run `yard`. Then run `yard diff huborg-<Huborg::VERSION> .yardoc` (where Huborg::VERSION is something like 0.1.0 and `.yarddoc` is the output directory of `yard`).
- [ ] Run `bundle exec rake changelog` to generate [CHANGELOG.md](./CHANGELOG.md)
- [ ] Review the new Huborg::VERSION CHANGELOG.md entries as they might prompt
you to consider a different version (e.g. what you thought was a bug fix
Expand Down

0 comments on commit e28c94a

Please sign in to comment.