docs: add notes to help beginners in getting started section #3945
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: CI | |
| on: | |
| pull_request: | |
| branches: ['master', 'stable'] | |
| push: | |
| branches: ['master', 'stable'] | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v2 | |
| with: | |
| node-version: '16' | |
| - uses: actions/cache@v2 | |
| with: | |
| path: '**/node_modules' | |
| key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }} | |
| - name: Install Dependencies | |
| run: yarn install | |
| - name: Lint | |
| run: yarn lint | |
| - name: Types | |
| run: yarn lint:typescript | |
| - name: Format | |
| run: yarn format:check | |
| - name: Verify Dependencies | |
| run: yarn checkDeps | |
| - name: Run Jest | |
| env: | |
| BROWSERSLIST_CONFIG: './packages/browserslist-config-clay/config' | |
| BROWSERSLIST_DISABLE_CACHE: 1 | |
| CI: true | |
| run: yarn test --coverage | |
| - name: Push to Coveralls | |
| if: ${{ success() }} | |
| uses: coverallsapp/[email protected] | |
| with: | |
| path-to-lcov: ./coverage/lcov.info | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| stats: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v2 | |
| with: | |
| node-version: '16' | |
| - name: Fetch and Diff | |
| id: diff | |
| run: | | |
| git fetch --no-tags --depth=1 origin ${{ github.event.pull_request.base.sha }} | |
| echo "##[set-output name=packages;]$(git diff --exit-code ${{ github.event.pull_request.base.sha }} 'packages/*')" | |
| - name: Checkout BASE | |
| if: ${{ steps.diff.outputs.packages }} | |
| uses: actions/checkout@v2 | |
| with: | |
| ref: ${{ github.event.pull_request.base.sha }} | |
| - name: Generate Build Info | |
| if: ${{ steps.diff.outputs.packages }} | |
| run: | | |
| yarn cache clean | |
| yarn install | |
| yarn build | |
| yarn genBuildSize | |
| - name: Clean directory | |
| if: ${{ steps.diff.outputs.packages }} | |
| run: | | |
| git clean -ffdx --exclude /tmp | |
| git reset --hard HEAD | |
| - name: Checkout HEAD | |
| if: ${{ steps.diff.outputs.packages }} | |
| uses: actions/checkout@v2 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| clean: false | |
| - uses: actions/setup-node@v2 | |
| with: | |
| node-version: '16' | |
| - name: Generate Bundle Size Table | |
| if: ${{ steps.diff.outputs.packages }} | |
| run: | | |
| yarn cache clean | |
| yarn install | |
| yarn build | |
| yarn genBuildSize:compare | |
| - name: Generate Total Size | |
| if: ${{ steps.diff.outputs.packages }} | |
| run: | | |
| yarn run sizeLimit |