Migration.md

Migration guide

3.0.2 -> 4.0.0

Custom statuses

Update the parameters config in preview.js:

export const parameters = {
  status: {
    statuses: {
      [... custom statuses]
    },
  },
};

Custom statuses will need a background color defined:

{
  perfect: {
    background: '#2e8b57',
    color: '#ffffff',
    description: 'Description of this status',
  },
}

Statuses in stories should now be written as an object:

export default {
  title: 'BetterSoftwareLink',
  parameters: {
    status: {
      type: 'beta', // 'beta' | 'stable' | 'deprecated' | 'releaseCandidate'
      url: 'http://www.url.com/status', // will make the tag a link
      statuses: {...} // add custom statuses for this story here
    }
  },
};

1.0.1 -> 2.0.0

Matt Stow pointed out we used 'depreciated' incorrectly when it should be 'deprecated'.

You'll need to find and replace status: 'depreciated' > status: 'deprecated'.