Skip to content

Commit

Permalink
Add Chromatic-specific publishing steps to README
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewortwein committed Sep 25, 2024
1 parent 0ee3d67 commit 3de72f9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@
rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web.

## Publishing @chromaui/rrweb-snapshot

Chromatic maintains this fork of `rrweb-io/rrweb` solely to publish a version of `rrweb-snapshot` that supports constructable stylesheets for Chromatic e2e capture purposes.

To distinguish Chromatic-specific builds from those coming from rrweb-io, a `-noAbsolute` label is appended to the end of the package version. If more than one Chromatic build is produced based off of the same rrweb-io version, a number is appended to the end of that label (e.g. `2.0.0-alpha.17-noAbsolute.1`).

1. In `packages/rrweb-snapshot/package.json`, set the appropriate `-noAbsolute.X` version
2. CD to `packages/rrweb-snapshot`
3. Run `npm publish`

## Guide

[**📚 Read the rrweb guide here. 📚**](./guide.md)
Expand Down

0 comments on commit 3de72f9

Please sign in to comment.