New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
chromatic
Advanced tools
chromatic - npm Package Compare versions
Comparing version 6.5.4 to 6.5.5-canary.2
| { | ||
| "name": "chromatic", | ||
| "version": "6.5.4", | ||
| "version": "6.5.5-canary.2", | ||
| "description": "Automate visual testing across browsers. Gather UI feedback. Versioned documentation.", | ||
@@ -38,3 +38,3 @@ "keywords": [ | ||
| "build": "npm-run-all --serial -l bundle:**", | ||
| "build-storybook": "build-storybook -s static", | ||
| "build-storybook": "build-storybook", | ||
| "build-test-storybook": "cross-env SMOKE_TEST=true build-storybook -o test-storybook", | ||
@@ -50,7 +50,6 @@ "build-subdir": "cd subdir ; yarn build ; cd ..", | ||
| "prepublish": "npm run build", | ||
| "postpublish": "npm run publish-action", | ||
| "publish-action": "node scripts/publish-action.js", | ||
| "release": "node scripts/release.js", | ||
| "trace": "node -r esm bin-src/trace.js", | ||
| "trim-stats": "node -r esm bin-src/trim-stats-file.js", | ||
| "storybook": "start-storybook -p 9009 -s static", | ||
| "storybook": "start-storybook -p 9009", | ||
| "test": "jest", | ||
@@ -91,5 +90,8 @@ "prepare": "husky install", | ||
| "@chromaui/localtunnel": "^2.0.3", | ||
| "@storybook/addon-essentials": "^6.5.5", | ||
| "@storybook/builder-webpack5": "^6.5.5", | ||
| "@storybook/eslint-config-storybook": "^3.1.2", | ||
| "@storybook/linter-config": "^3.1.2", | ||
| "@storybook/react": "^6.4.14", | ||
| "@storybook/manager-webpack5": "^6.5.5", | ||
| "@storybook/react": "^6.5.5", | ||
| "@types/archiver": "^5.3.1", | ||
@@ -149,3 +151,3 @@ "@types/async-retry": "^1.4.3", | ||
| "react-dom": "^17.0.2", | ||
| "semver": "^7.3.5", | ||
| "semver": "^7.3.7", | ||
| "slash": "^3.0.0", | ||
@@ -168,2 +170,6 @@ "sort-package-json": "1.50.0", | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "registry": "https://registry.npmjs.org/" | ||
| }, | ||
| "docs": "https://www.chromatic.com/docs/cli", | ||
@@ -170,0 +176,0 @@ "storybook": { |
@@ -20,2 +20,34 @@ # Chromatic CLI | ||
| ## Using a `next` version | ||
| From time to time we pre-publish a `next` version of the package to test new features. To use the | ||
| next branch you can either: | ||
| ### Using `npx` | ||
| Change your script to use the `next` dist-tag: | ||
| ```bash | ||
| npx chromatic@next --project-token ... | ||
| ``` | ||
| ### Using a dependency in `package.json` | ||
| Update to the latest `next` version with: | ||
| ```bash | ||
| yarn add --dev chromatic@next | ||
| # or | ||
| npm i --save-dev chromatic@next | ||
| ``` | ||
| ### Using the github action | ||
| Use our `chromatic-next` action: | ||
| ```yaml | ||
| - uses: chromaui/action-next@v1 | ||
| ``` | ||
| ## Contributing | ||
@@ -43,50 +75,35 @@ | ||
| - `yarn build` | ||
| - Updated CHANGELOG.md | ||
| - Committed and pushed everything | ||
| - Committed and pushed everything (clean working directory) | ||
| - Decide on the proper semver bump (major/minor/patch) | ||
| - Decide on the proper tag (canary/next/latest) | ||
| #### Doing a `canary` or `next` release | ||
| We have three types of releases: | ||
| We have two types of pre-releases: `canary` and `next`. `canary` releases are intended for development purposes and should not be used in production, as they may only work against a staging or dev environment. `next` releases should be valid, working releases that can potentially be used by early adopters of new features, for example to handle a support request. | ||
| - `canary` releases are intended for testing purposes and should not be used in production, as they may only work against a staging or dev environment. | ||
| - `next` releases should be valid, working releases that can potentially be used by early adopters of new features, for example to handle a support request. | ||
| - `latest` releases are the general audience production releases, used by most people. | ||
| > As a consumer, **you should not specify a tag** (e.g. `chromatic@next`) in your package dependencies, but rather a specific version number (e.g. `chromatic@5.6.2-next.0`). Otherwise you'll end up with a broken build when we remove or update the tag. | ||
| > For GitHub Actions, we publish `chromaui/action-canary` and `chromaui/action-next`, which contain the latest `canary` or `next` release, respectively. A `latest` release will also automatically update `chromaui/action-next` (besides `chromaui/action`), in order to keep users who happen to depend on `chromaui/action-next` up to date with the `latest` release. | ||
| For the first `canary` (or `next`) release, bump the version like so (depending on the semver bump): | ||
| A script is provided to create new releases: | ||
| ```sh | ||
| npm version <premajor|preminor|prepatch> --preid canary | ||
| yarn release <major|minor|patch> <canary|next|latest> [--dry-run] | ||
| ``` | ||
| For consecutive `canary` releases on the same version: | ||
| This script ensures the version is bumped properly, the tag is set correctly and the corresponding GitHub Action is updated. | ||
| ```sh | ||
| npm version prerelease --preid=canary | ||
| ``` | ||
| #### Examples: | ||
| Then push and publish: | ||
| ```sh | ||
| git push --follow-tags | ||
| npm publish --tag canary | ||
| yarn release patch canary | ||
| ``` | ||
| Make sure to replace `canary` with `next` if appropriate. | ||
| Releases e.g. `6.6.1-canary.0`. | ||
| #### Doing a `latest` release | ||
| A final release is automatically tagged `latest` by npm. | ||
| ```sh | ||
| npm version <major|minor|patch> | ||
| git push --follow-tags | ||
| npm publish | ||
| yarn release major latest | ||
| ``` | ||
| And finally, remove the `canary` and/or `next` tag, if any: | ||
| ``` | ||
| npm dist-tag rm chromatic canary | ||
| ``` | ||
| This ensures we can safely do a new `canary` or `next` release later, without anyone getting an unexpected update. | ||
| Releases e.g. `7.0.0`. |
Sorry, the diff of this file is not supported yet
New alerts
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Fixed alerts
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.38%
2353014
- Number of lines in readme file
- increased by18.68%
108
Worsened metrics
- Dev dependency count
- increased by3.57%
87
- Number of low quality alerts
- increased byInfinity%
1
No dependency changes