Skip to content

Instantly share code, notes, and snippets.

@shilman
Last active January 5, 2018 18:22
Show Gist options
  • Save shilman/7841ab4fd2a583b73fab22f5fabbc282 to your computer and use it in GitHub Desktop.
Save shilman/7841ab4fd2a583b73fab22f5fabbc282 to your computer and use it in GitHub Desktop.
Storybook Revised Release Proposal

Storybook Release Proposal v2

A Storybook release proposal that combines Semver with marketing considerations. In short:

  1. multiple major versions per year
  2. blog post for each major version

Motivation

Earlier this year I proposed a release strategy that attempted to reduce major versions. We've been running with that strategy for six months and have released 3.0, 3.2, and 3.3 this way, but continue to get pushback on adhering to Semver. This proposal attempts to address those concerns and is inspired by Jest's versioning.

Approach

We continue to do marketing releases of Storybook. However, these will be major releases instead of minor ones.

The approach:

  • Gather 3+ noteworthy "headline" features with clear user benefit
  • Publish a major release and a blog post

Under this strategy 3.2 would have been released as 4.0, and 3.3 would have been released as 5.0. In fact, technically they should have been major releases under semver since both contained breaking changes.

Pros and Cons

This approach:

  1. allows us to support semver more strictly
  2. still allows us to do marketing releases (and it's clear when)
  3. allows us to deprecate things more quickly and keep our codebase/documentation a lot more clean
  4. encourages users to upgrade to the latest despite breaking changes

Potential drawbacks:

  1. No way to denote huge changes (that are bigger than anything we've released so far)
  2. May potentially introduce major version bumps that don't contain breaking changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment