feat : add documentation to readme and fix second level titles (#625) #775
This file contains hidden or 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: 🔎 Code Quality | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| jobs: | |
| linter: | |
| name: 🧹 Linter | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 10 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 'lts/*' | |
| cache: 'pnpm' | |
| - name: Install deps | |
| run: pnpm install | |
| - name: Run eslint | |
| run: pnpm run lint:eslint --max-warnings 0 | |
| typescriptChecker: | |
| name: 🟦 TypeScript Checker | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node: [22, 24, 'lts/*'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 10 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| cache: 'pnpm' | |
| - name: Install deps | |
| run: pnpm install | |
| - name: Run Typescript checker | |
| run: pnpm run lint:ts | |
| tests: | |
| name: 🔬 Tests | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-latest | |
| env: | |
| VITE_BASE_URL: http://localhost:3000 | |
| strategy: | |
| matrix: | |
| node: [22, 24, 'lts/*'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 10 | |
| - name: Get pnpm store directory | |
| shell: bash | |
| run: | | |
| echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| cache: 'pnpm' | |
| - name: Cache node modules | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-node-modules | |
| with: | |
| path: ${{ env.STORE_PATH }} | |
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pnpm-store-${{ env.cache-name }}- | |
| ${{ runner.os }}-pnpm-store- | |
| ${{ runner.os }}- | |
| - name: Install deps | |
| run: pnpm install | |
| - name: Install Playwright Chromium | |
| run: pnpm exec playwright install chromium --with-deps | |
| - name: Run tests | |
| run: SKIP_ENV_VALIDATION=true pnpm run test:ci |