From e28c94a9c6a065bcbff414b2141733d966219a0a Mon Sep 17 00:00:00 2001 From: Jeremy Friesen Date: Mon, 2 Mar 2020 07:32:36 -0500 Subject: [PATCH] Adding guidance on determining Semantic Versioning 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 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1b8c229..44c576c 100644 --- a/README.md +++ b/README.md @@ -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- .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