docs: Update Contributing guidelines #64
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Pull Request | |
on: pull_request | |
jobs: | |
install: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: Workday/canvas-kit-actions/install@v1 | |
with: | |
node_version: 18.x | |
build: | |
runs-on: ubuntu-latest | |
needs: 'install' | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: Workday/canvas-kit-actions/install@v1 | |
with: | |
node_version: 18.x | |
- name: Build Tokens | |
run: yarn build:tokens --no-cache | |
- name: Build Storybook | |
run: yarn build-storybook --no-cache | |
- name: Cache Build | |
id: build-cache | |
uses: actions/cache@v3 | |
with: | |
path: docs | |
key: ${{ runner.os }}-build-${{ github.sha }} | |
check: | |
runs-on: ubuntu-latest | |
needs: ['install', 'build'] | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: Workday/canvas-kit-actions/install@v1 | |
with: | |
node_version: 18.x | |
# Keep steps separate for Github Actions annotation matching: https://github.com/actions/setup-node/blob/83c9f7a7df54d6b57455f7c57ac414f2ae5fb8de/src/setup-node.ts#L26-L33 | |
- name: Lint | |
shell: bash | |
run: yarn lint | |
- name: Build Tokens | |
run: yarn build:tokens --no-cache | |
- name: Type Check | |
shell: bash | |
run: yarn typecheck | |
- name: Run Unit Tests | |
shell: bash | |
run: yarn test | |
visual-test: | |
runs-on: ubuntu-latest | |
needs: 'build' | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 # Required to retrieve git history | |
- uses: Workday/canvas-kit-actions/install@v1 | |
with: | |
node_version: 18.x | |
- name: Restore Build | |
uses: actions/cache@v3 | |
with: | |
path: docs | |
key: ${{ runner.os }}-build-${{ github.sha }} | |
- uses: chromaui/action@main | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
projectToken: chpt_a9e354687a28e6e | |
storybookBuildDir: docs/storybook/@workday/canvas-tokens-docs/ | |
exitOnceUploaded: false | |
exitZeroOnChanges: true |