docs: Add more context for jobs #618
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: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: 📚 Git Checkout | |
| uses: actions/checkout@v4 | |
| - name: ⚙️ Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.12.x | |
| cache: npm | |
| cache-dependency-path: package-lock.json | |
| - name: 📦 Install Dependencies | |
| run: npm ci | |
| - name: ✨ Check Format | |
| run: npm run format:check | |
| - name: 🧹 Lint | |
| run: npm run lint | |
| - name: 🔤 Check Spelling | |
| run: npm run cspell "**" | |
| - name: 👷 Build website | |
| run: npm run build | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| steps: | |
| - name: 📚 Git Checkout | |
| uses: actions/checkout@v4 | |
| - name: ⚙️ Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.12.x | |
| cache: npm | |
| cache-dependency-path: package-lock.json | |
| - name: 📦 Install Dependencies | |
| run: npm ci | |
| - name: ✨ Check Format | |
| run: npm run format:check | |
| - name: 🧹 Lint | |
| run: npm run lint | |
| - name: 🔤 Check Spelling | |
| run: npm run cspell | |
| - name: 👷 Build website | |
| run: npm run build | |
| - name: ☁️ Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./dist | |
| user_name: github-actions[bot] | |
| user_email: 41898282+github-actions[bot]@users.noreply.github.com |