Skip to content

Commit

Permalink
πŸ”§ Prepare for v3 (#310)
Browse files Browse the repository at this point in the history
* πŸ”– Remove prerelease references

* πŸ“ Add @percy/migrate docs
  • Loading branch information
Wil Wilsman authored Mar 31, 2021
1 parent 520734e commit cbf0b25
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
1 change: 0 additions & 1 deletion .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ version-resolver:
- enhancement
default: patch
template: '$CHANGES'
prerelease: true
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ jobs:
key: v1/${{ runner.os }}/node-12/${{ hashFiles('**/yarn.lock') }}
restore-keys: v1/${{ runner.os }}/node-12/
- run: yarn
- run: npm publish --tag next
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,23 @@ $ percy exec -- cypress run

## Upgrading

### Automatically with `@percy/migrate`

We built a tool to help automate migrating to the new CLI toolchain! Migrating
can be done by running the following commands and following the prompts:

``` shell
$ npx @percy/migrate
? Are you currently using @percy/cypress? Yes
? Install @percy/cli (required to run percy)? Yes
? Migrate Percy config file? Yes
? Upgrade SDK to @percy/cypress@3.0.0? Yes
```

This will automatically run the changes described below for you.

### Manually

#### Installing `@percy/cli`

If you're coming from a pre-3.0 version of this package, make sure to install `@percy/cli` after
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@percy/cypress",
"description": "Cypress client library for visual testing with Percy",
"version": "3.0.0-beta.0",
"version": "3.0.0",
"license": "MIT",
"author": "Perceptual Inc.",
"repository": "https://github.com/percy/percy-cypress",
Expand Down

0 comments on commit cbf0b25

Please sign in to comment.