Skip to content

Latest commit

 

History

History
585 lines (356 loc) · 25.9 KB

CHANGELOG.md

File metadata and controls

585 lines (356 loc) · 25.9 KB
Raw

6.7.1 - 2002-07-22

  • 612 Add change count to buildPassed message if changes exist.

6.7.0 - 2022-06-30

  • 598 Enable bash mode for globs when matching branches with picomatch

6.6.4 - 2022-06-27

  • 590 Better onboarding support
  • 596 Handle redirects when using --storybook-url

6.6.3 - 2022-06-18

  • 8be428f Prevent split on undefined

6.6.2 - 2022-06-17

  • 592 Filter out unsupported addons from Storybook metadata

6.6.1 - 2022-06-17

  • 566 Handle commits that are missing from the repository (i.e. rebased) when doing TurboSnap
  • 562 Implement async build creation process
  • 585 Fix Storybook metadata retrieval

6.5.4 - 2022-04-7

  • 554 Downcase the slug so we don't accidentally treat origin as fork

6.5.3 - 2022-03-14

  • 536 Fix slug for GitHub's workflow_dispatch event
  • 547 Fix line splitting on Windows for Git output
  • 538 Bump url-parse from 1.5.3 to 1.5.10
  • 545 Bump ansi-html from 0.0.7 to 0.0.8
  • 528 Bump follow-redirects from 1.14.7 to 1.14.9

6.5.2 - 2022-03-11

  • 527 539 Fix TurboSnap support for Storybook in a subdirectory

6.5.1 - 2022-02-21

  • Fix: Cannot read property 'startsWith' of null

6.5.0 - 2022-02-21

  • 513 Add support for custom npm registry url
  • 521 Add TurboSnap support for Vite
  • 523 Fix TurboSnap support for Storybook 6.5 with .cjs extension
  • 518 Fix storybookUrl output by removing iframe.html suffix

6.4.3 - 2022-01-31

  • 505 Migrate to TypeScript

6.4.2 - 2022-01-28

  • 510 Fix pathname support in proxy URL
  • 0734f3a Fix how paths are normalized for TurboSnap

6.4.1 - 2022-01-20

  • 499 Fix handling of CANCELLED build status
  • 501 Fix handling of missing ref and/or sha inputs on workflow_dispatch event #501
  • 503 Reformat help text and move allowConsoleErrors to deprecated options
  • 504 Fix consistent naming of flags for trace util

6.4.0 - 2022-01-18

  • 495 TurboSnap: Add --trace-changed flag and trace utility
  • 490 TurboSnap: Detect mismatching entry file and suggest a fix
  • 502 Add --force-rebuild to prevent skipping on rebuild
  • 500 Use commit author info instead of committer info
  • 487 Improve how process exit code is set
  • 488 Fix --untraced for package files
  • 474 Fix commit status update for UI Review when using --skip

6.3.4 - 2022-01-10

  • 492 Fix missing exit code on rebuild
  • 491 Fix storybookBaseDir option in GitHub Action

6.3.3 - 2021-12-22

  • Filter empty values in array flags and restore warnings

6.3.2 - 2021-12-22

  • Disable warning about --externals requiring --only-changed

6.3.1 - 2021-12-22

  • Disable warning about --untraced requiring --only-changed

6.3.0 - 2021-12-22

  • 461 Add --untraced flag to avoid retesting stories that depend on certain files
  • 479 Add --diagnostics flag to write process context data to a file
  • 458 Track bailReason, improve TurboSnap messaging and throw on zero CSF globs
  • 482 Fix commit details when using env var and warn if the commit is missing

6.2.3 - 2021-12-17

  • Avoid optional chaining which breaks in Node 12 (GitHub Actions)

6.2.2 - 2021-12-17

  • Fix error handling in GraphQL client to not retry mutation on HTTP error

6.2.1 - 2021-12-16

  • 477 Retry createBuild based on error messages
  • 468 Increase unpack wait timeout to 3 minutes
  • 466 Add workingDirectory input handler for action
  • 465 Remove the need to set a GitHub token

6.2.0 - 2021-12-07

  • 459 Add --zip flag to upload files as zip archive
  • 463 Fix tests of makeZipFile
  • 447 Add support for passing the same flag multiple times

6.1.0 - 2021-11-29

  • 455 Add --storybook-base-dir to support TurboSnap with a prebuilt Storybook originating from a subdirectory
  • 456 Add --dry-run to skip publishing
  • 444 Add support for proxy authentication
  • 457 Throw error rather than bailing out of TurboSnap when tracing changed files fails

6.0.6 - 2021-11-10

  • 449 Fix TurboSnap for unnamed modules in Webpack 5 stats file
  • 442 Set exitCode to 0 when branch is skipped with skip flag

6.0.5 - 2021-10-27

  • 440 Add TurboSnap support for 6.4 virtual story file locations
  • 440 Fix TurboSnap for files that are chunked with preview files
  • 436 Fix DEBUG env variable being set
  • 424 Update GitHub Action to use Node 14
  • 433 Add optional window arg to isChromatic

6.0.4 - 2021-10-13

  • Fix issue with node:path import caused by meow v10.

6.0.3 - 2021-10-13

  • Fix --only-changed to bail on changes to package.json, package-lock.json or yarn.lock located at the repository root.

6.0.0 - 2021-10-12

  • 393 Bundle the bin & action so it's dependency-less
  • 393 Add support for workflow_run event
  • 393 Make lookup of storybook version optional
  • Make isChromatic the package main entry point
  • Remove the deprecated Storybook addon

Before:

import isChromatic from 'chromatic/isChromatic';

After:

import isChromatic from 'chromatic';

5.10.1 - 2021-09-21

  • 404 Fix the version of node-fetch to 2.6.0 due to a bug in 2.6.3

5.10.0 - 2021-09-17

  • 311 Support workflow_dispatch event in GitHub Action
  • 382 Support absolute paths in webpack stats
  • 370 Ignore --only-changed on rebuild
  • 381 Throw when specifying an invalid loglevel
  • 392 Better path handling for TurboSnap
  • 374 Fix handling of NO_PROXY environment variable
  • 397 Fix runtime issues with HTTP_PROXY / NO_PROXY
  • 380 Fix isChromatic for server-side rendering
  • 401 Update BuildHasChanges message to be clearer

5.9.2 - 2021-06-15

  • 366 Fix resolving webpack stats in subdirectory

5.9.1 - 2021-06-14

  • 365 Fix cross-fork builds from GitHub Action

5.9.0 - 2021-06-02

  • 347 Add support for proxy server
  • 334 Check existence and validity of package.json
  • 355 Ignore --only-changed on changes matching --externals

5.8.3 - 2021-05-21

  • 350 Restore original preferLocal settings for Execa

5.8.2 - 2021-05-19

  • 348 Restore original behavior to use npm_execpath

5.8.1 - 2021-05-18

  • 345 Restore implying of --preserve-missing when using --only
  • 344 Fix determining viewLayer when using transitive dependency
  • 337 Fix chromatic script that can be added to package.json
  • 331 Log clientVersion on fatal error

5.8.0 - 2021-04-29

  • 319 Retrieve viewLayer and version from dependencies and support @web/dev-server-storybook
  • 313 Use original baseline for rebuilds (new build for the same commit)
  • 304 Support only testing components affected by recent git changes via --only-changed
  • 305 Fix npx chromatic timing out on build-storybook

5.7.1 - 2021-02-02

  • Better logging when Storybook validation fails

5.7.0 - 2021-03-11

  • 283 Explicitly allow multiple project-tokens (last will be used)
  • 301 Strip origin/* prefix from branch name
  • 297 Add @storybook/vue3 support
  • 296 Support Yarn 2 execpath
  • 295 Gracefully handle git config command in Netlify
  • 284 Fix storybookUrl in GitHub Action
  • 287 Update CLI to use new test terminology and statuses
  • 298 Document GitHub action outputs
  • 306 Fix tunnel builds

5.6.3 - 2021-02-17

  • 282 Revert meow upgrade (will upgrade again in next major release)

5.6.2 - 2021-02-10

  • 269 Record CI service name on build
  • 278 Fix 10-minute timeout in gh action

5.6.1 - 2021-01-22

  • Update @chromaui/localtunnel dependency to patch Axios security vulnerability

5.6.0 - 2021-01-12

  • 233 Add --branch-name flag to override branch name
  • 193 Record the repository slug to support builds from forks
  • 237 Avoid passing --silent when invoking npm through Node.js script
  • 231 Fix overriding Storybook version through environment variable

5.5.0 - 2020-12-20

  • 212 Add support for monorepo using a new path argument
  • 218 isChromatic should always be a boolean
  • Dependency upgrades

5.4.0 - 2020-11-16

  • Throw error when running from shallow clone.
  • Improve error messages for when build-storybook fails.
  • Add support for pull_request_target and pull_request_review events to GitHub Action.

5.3.0 - 2020-10-29

  • Retrieve branch name using more modern git commands, if available.
  • Auto-detect buildScriptName from available scripts.
  • Improve various log messages.

5.2.0 - 2020-09-14

  • Keep track of baselines when doing squash or rebase merges.

5.1.0 - 2020-08-03

  • If the build directory we defined is empty, try to detect the actual build output directory from the Storybook build log and warn about it.
  • Show a user-friendly error message if we still don't find any Storybook files to publish.
  • We now read package.json using pkgUp, so theoretically you can run chromatic from a subdirectory.
  • Added the --output-dir (-o) flag to use instead of a temp dir.
  • Added buildScript to the error json output so we won't have to ask for it in support every time.
  • Added a global promise rejection handler, in case we accidently forget to catch them.
  • Added a user-friendly error message when build-storybook fails.
  • Fixed the --debug flag so it actually prints something.
  • Fixed the --only flag.
  • Fixed issue with node-loggly-bulk when using Yarn 2.

5.0.0 - 2020-06-19

  • Completely overhauled the CLI, with improved UX and better error handling
  • Removed JSDOM and its shims to avoid a whole category of issues with broken builds
  • Added a version upgrade check that warns when a new major update is available
  • Added --junit-report to generating build reports for integration with other tools
  • Changed --only to accept a simple glob
  • Moved documentation to the Chromatic website

4.0.3 - 2020-05-18

  • Replace child_process.execSync with execa
  • ADD mock for execCommand in JSDOM

4.0.2 - 2020-04-26

  • REMOVE node_env development chromaui#81
  • ADD ability to create a patch build for pull requests
  • ADD extra parameters to upload chromaui#107
  • IMPROVE readability of error message from build-storybook chromaui#112
  • IMPROVE user experience during onboarding
  • RENAME appCode to projectToken chromaui#109
  • REMOVE adding a environment variable when adding script, use cli flag instead chromaui#105

3.5.2 - 2020-02-18

  • FIX version of JSDOM to 16.1 as 16.2 includes a conflicting custom element support chromaui#95

3.5.1 - 2020-02-06

3.5.0 - 2020-01-28

  • CHANGE so the CLI stop on storybook runtime errors chromaui#75
  • ADD a flag (--allow-console-errors) to continue on storybook runtime errors chromaui#75
  • ADD early warning system for if the storybook output folder is empty chromaui#78
  • IMPROVE readability of the error when build-storybook fails chromaui#73
  • IMPROVE readability of the error when storybook runtime throws an error chromaui#73
  • FIX Intl.PluralRules.supportedLocalesOf is not a function error chromaui#76

3.4.0 - 2019-12-25

  • FIX pubish script

3.3.0 - 2019-12-25

  • IMPROVE logging when git fails
  • FIX script for windows
  • ADD --exit-once-uploaded flag
  • FIX escape chararacters in error messages

3.2.0 failed upload to npm

3.1.0 - 2019-11-04

  • ADD jsdom shim for SVG elements
  • ADD jsdom shim for fetch
  • Bugfix jsdom shim for Intl

3.0.3 - 2019-10-15

  • ADD compatibility with github action
  • ADD test with github action
  • ADD compatibility with github env vars for tracing git branch
  • Bugfix running on windows by using cross-spawn

3.0.2 - 2019-10-09

  • ADD licence file
  • Bugfix compatibility with CHROMA_APP_CODE
  • Bugfix report list of addons

3.0.1 - 2019-10-08

  • ADD chroma bin

3.0.0 - 2019-10-03

  • Bugfix indentation of messages in terminal
  • REMOVE the need for the clientside addon
  • unify the 2 related packages into a single repository

2.2.2 - 2019-08-25

  • Bugfix for compatibility with localtunnel`

2.2.0 - 2019-08-23

  • Add support for docs-mode (Storybook 5.2 feature).

  • Add support for a new parameter: pauseAnimationsAtEnd. Read about it here: https://www.chromatic.com/docs/animations

  • Retry requests to uploading storybooks in case of network problems.

2.1.1 - 2019-08-06

  • Upgrade axios dependency for security update

2.1.0 - 2019-07-17

  • Add a --skip flag to indicate a commit is not going to be built (and still tag the PR as passing).
  • Allow chromatic story parameters to be functions of ({ id, kind name }) -- in particular e.g. chromatic: { viewport: () => [/*something dynamic based on story info */]}
  • A fix for issues involving story listings differing between browsers.

2.0.0 - 2019-07-17

  • We now default to building and uploading your storybook, rather than starting and tunneling it. This has many benefits including increased reliability and better support for Live View. You'll need to ensure you have a build-storybook script defined in package.json (as added by the Storybook CLI). To get the old behaviour, pass -s to the chromatic test command.

  • We now support HTTPS storybooks (using the --ssl flag and friends).

  • We polyfill window.Intl in our JSDOM environment.

  • We polyfill window.customElements in our JSDOM environment.

1.4.0 - 2019-06-20

  • Retry requests to the API server if one fails rather than bailing out on builds.

1.3.3 - 2019-04-19

  • Fixed issue with uploaded builds and Storybook 5 URLs.

1.3.2 - 2019-04-02

  • Added a new diffThreshold Storybook parameter you can use to control the anti-aliasing threshold we use for diffing if you find that certain images are tripping our diff.

  • Fix an issue with handling rebased branches in unusual CI systems.

1.3.1 - 2019-03-21

  • Add a dedicated endpoint for isChromatic so you don't need to load our full package to use it (which is useful if you want to use it inside your app, which we generally don't advise).

1.3.0 - 2019-02-28

  • Change the default behaviour around starting the storybook; if we find something running on the port, we assume it's your storybook, instead of requiring you to pass -S/--do-not-start.

  • Add a new flag --preserve-missing which means any stories that are missing from the last build will be assumed to be unchanged. Use this if you are doing tricky things around dynamically building your Storybook based on code changes.

1.2.6 - 2019-02-05

  • Fix an issue with Angular/zone.js failing to patch our MutationObserver mock

1.2.5 - 2019-01-30

  • Fix an issue with using isChromatic() inside Jest (storyshots).

  • Some rendering timing fixes to better support Storybook version 5

1.2.4 - 2019-01-18

  • Added an export isChromatic() to determine if code is running under test.

  • Added JSDOM mocks for CreateObjectUrl and MutationObserver

  • Added a parameter { chromatic: { disable: true } } to skip a story in chromatic

  • Added a parameter { chromatic: { noScroll: true } } to avoid scrolling screenshots in (non-chrome) browsers.

1.2.3 - 2018-12-28

  • Allow overwriting the polyfills we create in JSDOM mode. (This is a bugfix for some libraries that bundle their own polyfills).

1.2.2 - 2018-12-10

  • Allow controlling package initialization timing via import configure from 'storybook-chromatic/configure'; configure()

  • Add a flag --ignore-last-build-on-branch=X to not use the last build on a branch no matter what (which helps with rebasing, see: http://chromatic.com/docs/branching-and-baselines#rebasing).

1.2.1 - 2018-12-04

  • Update logging dependency from loggly to node-loggly-bulk due to security vulnerabilities. NOTE: this package was only used by our CLI tool and so there is no need for concern, but this new version should avoid tripping security tools.

1.2.0 - 2018-10-29

1.1.0 - 2018-10-15

  • Fix to work on Windows CI

  • Added a --storybook-build-dir parameter that allows you to upload a pre-built storybook.

1.0.2 - 2018-08-23

  • Fix a bug with Live View and Storybook@3.4

1.0.1 - 2018-07-26

  • We now set the CHROMATIC_APP_CODE variable for you, with explicit instructions to remove it (and set via CI) in less secure applications.

  • Some small bugfixes to support unusual usages.

1.0.0 - 2018-07-02

  • Renamed the package from react-chromatic to storybook-chromatic, to indicate support for all view layers that Storybook supports!

  • Tweaked to focus soley on Storybook -- simply import 'storybook-chromatic'; (no /storybook-addon required). Run tests with chromatic test --app-code (no --storybook-addon required).

  • Changed some URL parameters for the test command:

    • --port renamed --storybook-port
    • --url renamed --storybook-url
    • --app-path removed (it's always /iframe.html, as per Storybook).
    • --exec added to run arbitrary commands as an alternative to --script-name
    • --no-interactive added to disable interactive mode (and we do so automatically when on CI)

  • We no longer require you to have npm installed if you are using yarn.

  • Small bug fixes for missing git repositories, various failure modes.

  • We now track your Storybook version and view layer so we know when to ship/change features.

As react-chromatic

0.8.4 - 2018-06-07

  • Fix an issue for stories that use navigator.mimeTypes

0.8.3 - 2018-04-26

  • Fix a bug where sometimes the package did not detect the checked out branch.

0.8.2 - 2018-04-18

  • Better support for rebasing branches - we now always treat the last build on this branch as a baseline, even if strictly it is not a git ancestor of the current commit. This helps deal with the situation where you rebase a branch off main, and still want to use the previously approved snapshots.

  • Improved support for CI systems, especially Netlify and Travis PR builds. Travis PR builds are a special case, read more about how to handle them in Chromatic here: https://www.chromatic.com/docs/ci#travis

0.8.1 - 2018-03-28

  • Fix a small bug in the git algorithm for old Chromatic projects.

0.8.0 - 2018-03-28

  • Reworked the git baseline detection algorithm to use a different technique that should be more reliable across many different modes of usage.

  • Gather stories from Storybook 3.4 without requiring direct installation.

  • Added --auto-accept-changes to avoid approvals on certain branches

  • Added --only flag to run a single story

0.7.11 - 2018-03-15

  • Handle the case where the last few Chromatic builds were run against commits which are no longer in the repository (due to rebasing or squashing). This could cause the tool to crash or fail to find a baseline for a build.

  • Add a --url argument to allow running tests against arbitrary running apps.

0.7.10 - 2018-02-22

  • Small API change for querying build change counts.

0.7.9 - 2018-01-23

  • Our test script now warns you if your Storybook logs any errors. This can sometimes help reveal subtle problems that are caused by the script evaluating your Storybook in JSDOM. If you have legitimate things logged to console.error this may cause noise---you should probably get rid of them.

0.7.8 - 2018-01-18

  • We no longer write your app code to your package.json by default; instead we prefer you pass it via the CHROMATIC_APP_CODE environment variable. (You can still optionally use --app-code=xyz if you are comfortable with the security of your package.json).

  • We now show the final part of your Story's kind as the component name in the Chromatic UI. So "Webapp/UserList" will appear in Chromatic as "UserList".

0.7.7 - 2017-12-21

  • This version sends us a little more information about the environment the package runs in -- is it CI? which package version?

0.7.6 - 2017-12-19

  • Fix an issue where we did not pass the context to stories in the right format.

0.7.5 - 2017-12-19

  • We detect a running process on your app's port and don't try and start the app if so. Pass --do-not-start if you've already started the app.

0.7.3 - 2017-12-09

  • We now upload your application bundle to our tunnel server directly from the package. This means that on slower uplinks, we no need to set arbitrary timeouts in our server process; instead we simply will not start your Chromatic build until we've verified the bundle has uploaded successfully.