Github Actions Workflow Deploy SvelteKit Github Pages

pages.yml

# Updated from SvelteKit docs. See https://kit.svelte.dev/docs/adapter-static#github-pages for more information

name: Deploy to GitHub Pages

on:
  push:
    branches: 'main'

jobs:
  build_site:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      # If you're using pnpm, add this step then change the commands and cache key below to use `pnpm`
      # - name: Install pnpm
      #   uses: pnpm/action-setup@v3
      #   with:
      #     version: 8

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - name: Install dependencies
        run: npm install

      - name: build
        env:
          BASE_PATH: '/${{ github.event.repository.name }}'
        run: |
          npm run build

      - name: Upload Artifacts
        uses: actions/upload-pages-artifact@v3
        with:
          # this should match the `pages` option in your adapter-static options
          path: 'build/'

  deploy:
    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
        id: deployment
        uses: actions/deploy-pages@v4

Need to update to latest versions

actions/checkout@v4
actions/setup-node@v4
actions/upload-pages-artifact@v3
actions/configure-pages@v4
actions/deploy-pages@v4

Documentation for this present here,
https://kit.svelte.dev/docs/adapter-static

@pyrossh I appreciate the help updating this workflow file. In all honesty, using the one in the SvelteKit docs is probably the best option at this point.

@AndrewLester Does it make sense to delete this gist? Seems like this is the first one when searched Github Actions sveltekit. I think it would be good to update the SEO in the docs to improve ranking in google.

Lol I didn't realize this traffic was from google search. I don't see the docs in those results either unfortunately... I can just copy in the one from docs here and link to it in this gist to help out.

Hey I ran into 1 error. Can you please help me. this keeps happening for some reason

I had the same error, and then figured out I forgot to configure the svelte's static adapter in svelte.config.js! (see more in the doc shared by @pyrossh)