docs: add some info into readmes #125
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
| # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions | |
| name: Main | |
| on: | |
| push: | |
| branches: [main, next] | |
| pull_request: | |
| branches: [main, next, develop] | |
| jobs: | |
| validate_node_lts: | |
| # only want to use codecov for node latest long-term-support | |
| name: Validate Using Latest Node LTS | |
| runs-on: ubuntu-latest | |
| if: "!contains(github.event.head_commit.message, 'skip ci')" | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: pnpm/[email protected] | |
| with: | |
| version: 8.6.1 | |
| - name: Use Node.js 18 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| cache: pnpm | |
| - run: pnpm install --frozen-lockfile | |
| - run: pnpm build --filter="./packages/*" | |
| - run: pnpm lint | |
| - run: pnpm typecheck | |
| # # Check if there are uncommitted generated changes | |
| # - run: pnpm --filter docs api-pages | |
| # - run: pnpm --filter docs mdx-pages | |
| # - run: pnpm --filter docs scss-lookup | |
| # - run: pnpm --filter docs prism-themes | |
| # - run: git diff --quiet | |
| - run: pnpm test -- -- --coverage | |
| - run: npx codecov -t ${{ secrets.CODECOV_TOKEN }} | |
| # validate_matrix: | |
| # name: Validate Using Node Matrix | |
| # runs-on: ubuntu-latest | |
| # if: "!contains(github.event.head_commit.message, 'skip ci')" | |
| # strategy: | |
| # matrix: | |
| # node-version: [16.x] | |
| # steps: | |
| # - uses: actions/checkout@v3 | |
| # - uses: pnpm/[email protected] | |
| # - name: Use Node.js ${{ matrix.node-version }} | |
| # uses: actions/setup-node@v3 | |
| # with: | |
| # node-version: ${{ matrix.node-version }} | |
| # cache: pnpm | |
| # - run: pnpm install --frozen-lockfile | |
| # - run: pnpm lint | |
| # - run: pnpm typecheck | |
| # - run: pnpm test |