Skip to content
Build & Test CI

docs: add additional contribution documentation #8734

Sign in to view logs

docs: add additional contribution documentation

docs: add additional contribution documentation #8734

Workflow file for this run

.github/workflows/test.yml at b90e42f
name: Build & Test CI
on:
push:
workflow_call:
secrets:
CHROMATIC_PROJECT_TOKEN:
required: true
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup node 😻
uses: actions/setup-node@v3
with:
node-version-file: '.node-version'
cache: 'yarn'
- name: Install Dependencies ⬆️
run: yarn install --immutable
- name: Type check 📋
run: yarn run types
- name: Run CI Tests ✅
run: yarn run test:ci
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
CI: true
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup node 😻
uses: actions/setup-node@v3
with:
node-version-file: '.node-version'
cache: 'yarn'
- name: Install Dependencies ⬆️
run: yarn install --immutable
- name: Build Dist 🔧
run: yarn run build
# Rollup's TS plugin can include an implicit dependency on tslib that we don't want. It shouldn't be
# included in builds if our tsconfig.json configures "target" properly, which this check ensures.
- name: Check for "tslib" in build
run: |
if grep -r '--include=*.'{cjs,js} 'tslib' ./lib -q
then
echo "tslib found in lib"
exit 1
fi
storybook:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0 # 👈 Required to retrieve git history
- name: Install dependencies
run: yarn install --immutable
- name: Build design tokens
run: yarn build:tokens
- name: Build Storybook 📚
run: yarn build:storybook --webpack-stats-json
- name: Publish to Chromatic 🦄
run: |
yarn run chromatic \
--project-token=${{ secrets.CHROMATIC_PROJECT_TOKEN }} \
--storybook-build-dir storybook-static \
--exit-zero-on-changes \
--exit-once-uploaded \
--auto-accept-changes '{main,next}' \
--only-changed \
--skip 'dependabot/**'
- name: Run Accessibility Tests 💛
run: yarn run storybook:axeOnly
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup node 😻
uses: actions/setup-node@v3
with:
node-version-file: '.node-version'
cache: 'yarn'
- name: Install Dependencies 🧶
run: yarn install --immutable
# required since there are references to built tokens
- name: Build design tokens 🛠️
run: yarn build:tokens
- name: Lint Javascript + SCSS 👕
run: yarn run lint --max-warnings=0
commitlint:
name: Lint Commit Messages 👕
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup node 😻
uses: actions/setup-node@v3
with:
node-version-file: '.node-version'
cache: 'yarn'
- name: Install Dependencies 🧶
run: yarn install --immutable
- name: Validate commits commitlint
# This workflow can also be triggered via "workflow_call".
# Since it's a push event we have access to these properties https://docs.github.com/en/webhooks/webhook-events-and-payloads#push
# Filtering on just the (required) .id https://docs.github.com/en/actions/learn-github-actions/expressions#object-filters
if: github.event_name == 'push' && github.ref != 'refs/heads/main'
run: |
COMMIT_COUNT=$(echo '${{ toJSON(github.event.commits.*.id) }}' | jq length)
echo "Number of commits in the push: $COMMIT_COUNT"
yarn commitlint --from HEAD~$COMMIT_COUNT --to HEAD --verbose