Skip to content
This repository has been archived by the owner on Sep 8, 2021. It is now read-only.

Commit

Permalink
Updating for beta
Browse files Browse the repository at this point in the history
  • Loading branch information
jpvalery committed Oct 14, 2019
1 parent 0118364 commit 08a8ee8
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ Build with Yarn, Snapshot with Percy

GitHub Action to build your project with Yarn followed by Percy snapshots.

## Under development
- [] Fix #3
- [] Implement #2
- [] QA and release

## Requirements

You'll need to set up a secret `PERCY_TOKEN`.
Expand All @@ -16,8 +11,7 @@ Read more about [secrets with GitHub](https://help.github.com/en/articles/virtua

## How to use

Copy and paste this in your workflow

Just add this to `.github/workflows/main.yml`
```yaml
name: CI

Expand All @@ -32,18 +26,15 @@ jobs:

steps:
- uses: actions/checkout@v1
- name: Yarn Install
run: yarn install
- name: Yarn Build
run: yarn build
- name: Percy
run: yarn percy snapshot ./public
- name: Yarn & Percy CI
uses: jpvalery/yarn-percy-ci@master
env:
PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}

```

Goal of this action is to replace this above by
### Don't want to use this action?

You could just copy/paste this code instead.

```yaml
name: CI
Expand All @@ -59,8 +50,16 @@ jobs:

steps:
- uses: actions/checkout@v1
- name: Action> Yarn & Percy CI
uses: jpvalery/yarn-percy-ci@master
- name: Yarn Install
run: yarn install
- name: Yarn Build
run: yarn build
- name: Percy
run: yarn percy snapshot ./public
env:
PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
```

## Thanks

Thanks to Wil from Percy.io for all his help in troubleshooting this action.

0 comments on commit 08a8ee8

Please sign in to comment.