feat: initial commit #34
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: SDV Documentation | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: "docs" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js 18.x | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "18.x" | |
| cache: "npm" | |
| cache-dependency-path: "**/package-lock.json" | |
| - name: Installing dependencies | |
| run: npm ci | |
| - name: Linting the docs code | |
| run: npm run lint | |
| working-directory: "docs" | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| with: | |
| static_site_generator: next | |
| - name: Building docs | |
| run: npm run build | |
| - name: Uploading artifacts | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/out | |
| deploy: | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: "docs" | |
| needs: build | |
| steps: | |
| - name: Publish to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |