[Dev] readme: improve the readme x2 #5
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
| # https://gist.github.com/CarlosGDCJ/747032bea4f8506faeca1cffc926abaf | |
| # https://github.com/MapReduceMages/turing_machine/blob/main/.github/workflows/deploy.yml | |
| # https://www.okupter.com/blog/deploy-sveltekit-website-to-github-pages | |
| # https://github.com/MapReduceMages/turing_machine/blob/main/svelte.config.js | |
| # Workflow to build and deploy a SvelteKit website to GitHub Pages | |
| name: Deploy static SvelteKit content to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ['main'] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: false | |
| jobs: | |
| build-site: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Install Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 21 | |
| cache: npm | |
| - name: Install dependencies | |
| run: npm i | |
| - name: Build | |
| env: | |
| BASE_PATH: "/${{ github.event.repository.name }}" | |
| run: | | |
| npm run build | |
| - name: Archive build | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| # this should match the `pages` option in your adapter-static options | |
| path: "build/" | |
| - name: Upload Artifacts | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| # this should match the `pages` option in your adapter-static options | |
| path: "build/" | |
| deploy: | |
| if: github.ref == 'refs/heads/main' | |
| needs: build-site | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |