Skip to content

Commit

Permalink
Bump version 0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mirisuzanne committed May 26, 2017
1 parent 7c9fd67 commit 5e4541a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
34 changes: 23 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
# Herman Changelog

## 1.0.0: unreleased

- Display source and compiled code (njk and html; scss and css) side-by-side.
Closes [#65](https://github.com/oddbird/sassdoc-theme-herman/issues/65).
- Add support for @todo annotation. Closes
[#18](https://github.com/oddbird/sassdoc-theme-herman/issues/18).
- Show compiled CSS for `@example scss` annotations. Closes
[#37](https://github.com/oddbird/sassdoc-theme-herman/issues/37).
## 0.6.0: 2017-05-26

- Display links on index pages to project home and source,
when defined in the project `package.json`
[#91](https://github.com/oddbird/sassdoc-theme-herman/issues/65)
- Clean up display of parameters and properties –
[#53](https://github.com/oddbird/sassdoc-theme-herman/issues/53) and
[#49](https://github.com/oddbird/sassdoc-theme-herman/issues/49) and
[#55](https://github.com/oddbird/sassdoc-theme-herman/issues/55)
- Display source and compiled code (njk and html; scss and css) side-by-side –
[#65](https://github.com/oddbird/sassdoc-theme-herman/issues/65)
- Add support for @todo annotation –
[#18](https://github.com/oddbird/sassdoc-theme-herman/issues/18)
- Add support for @type annotation –
[#19](https://github.com/oddbird/sassdoc-theme-herman/issues/19)
- Add support for @alias (and aliased callback) annotation –
[#5](https://github.com/oddbird/sassdoc-theme-herman/issues/5)
- Add support for used-by (@require annotation callbacks).
- Show compiled CSS for `@example scss` annotations –
[#37](https://github.com/oddbird/sassdoc-theme-herman/issues/37)
- BREAKING: Nest Herman-specific options under `herman` object in sassdoc
configuration, and Sass-specific options under `herman.sass` object.
- Re-brand with sidebar navigation. Closes
- Re-brand with sidebar navigation
[#58](https://github.com/oddbird/sassdoc-theme-herman/issues/58) and
[#69](https://github.com/oddbird/sassdoc-theme-herman/issues/69).
- Add support for rendering documentation from dependency subprojects.
Closes [#61](https://github.com/oddbird/sassdoc-theme-herman/issues/61).
- Add support for rendering documentation from dependency subprojects
[#61](https://github.com/oddbird/sassdoc-theme-herman/issues/61).
- BUGFIX: Do not link to internal `@access private` items if `display` option
is set to `access: ['public']`.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "sassdoc-theme-herman",
"description": "An Odd SassDoc theme.",
"version": "0.5.5",
"version": "0.6.0",
"homepage": "http://oddbird.net/open-source/herman/",
"keywords": [
"sassdoc-theme"
Expand Down

5 comments on commit 5e4541a

@jgerigmeyer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This includes enough breaking changes that I think a minor version bump isn't really appropriate. Should probably be 1.0.0-alpha.1 or something.

@mirisuzanne
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I always assume the rules are different before 1.0 - you just can't bump versions semantically without going to 1 when you're likely to make breaking changes with every release.

@davisagli
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with Jonny. From what I understand with semantic versioning 1.0 does not mean "it's ready!" (when is it ever ready? "1.0" always feels arbitrary to me) but "we just broke things the first time".

@jgerigmeyer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mirisuzanne I understand what you're saying, but don't see how that works well in practice. We're using a number of packages <1.0, but I wouldn't expect a minor or patch version to include breaking changes.

@mirisuzanne
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. I understood it differently. You can pull that version and re-release if you think it's a problem.

Please sign in to comment.