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

Commit

Permalink
adding usage
Browse files Browse the repository at this point in the history
  • Loading branch information
jpvalery committed Oct 8, 2019
1 parent b501c3d commit 7d64ab7
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Yarn & Percy CI
Build with Yarn, Snapshot with Percy

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

## Under development

Expand All @@ -10,3 +10,20 @@ GitHub Action to build your project with Yarn followed by Percy snapshots.
You'll need to set up a secret `PERCY_TOKEN`.

Read more about [secrets with GitHub](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) and [Percy Token](https://docs.percy.io/docs/environment-variables).

## How to upcase

```yaml
on: [push]

jobs:
yarn_percy_ci_job:
runs-on: ubuntu-latest
name: Build with Yarn, Snapshot with Percy
steps:
- name: Yarn & Percy CI
id: yarn-percy-ci
uses: jpvalery/yarn-percy-ci@master
env:
PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
```

0 comments on commit 7d64ab7

Please sign in to comment.