:octocat: GitHub Action for Sapper

Use this action to build your static website with Sapper.

☝️ How to use?

To use it, create a .github/workflows/sapper_build.yml file in your Sapper-based website repository as an action.

πŸ“Œ Tip: read this article to more understand GitHub Actons steps.

βš™οΈ Inputs

This action accepts a couple of optional inputs:

Input Name Required? Default Description
build_mode No "export" Build mode to the Sapper
args No none Arguments to pass to the Sapper invocation

For example:

- name: Build
  uses: truewebartisans/actions-sapper@master
  with:
    build_mode: "export"
    args: "--legacy --entry about"

πŸ‘€ More complex examples

These are examples, which builds the website with this action, then deploys with another action.

πŸ’‘ Deploy to GitHub Pages

name: Build Sapper and Deploy to GitHub Pages

on: [push]

jobs:
  build_deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Build Sapper
        uses: truewebartisans/actions-sapper@master
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@master
        with:
          publish_dir: __sapper__/export
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}

πŸ“Ί GitHub Pages demo repository

This demo for Sapper-based website was build with export flag and deployed to GitHub Pages from gh-pages branch.

πŸ’‘ Deploy to remote virtual server (VDS/VPS/Droplet) via SSH

name: Build Sapper and Deploy to remote virtual server via SSH

on: [push]

jobs:
  build_deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Build Sapper
        uses: truewebartisans/actions-sapper@master
        with:
          build_mode: "build"
      - name: Deploy to remote virtual server via SSH
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.REMOTE_HOST }}
          username: ${{ secrets.REMOTE_USER }}
          key: ${{ secrets.SSH_KEY }}
          passphrase: ${{ secrets.SSH_KEY_PASSPHRASE }}
          rm: true
          source: __sapper__/build/
          target: ${{ secrets.REMOTE_DIR }}

πŸ“š License

MIT © Vic ShΓ³stak & True web artisans.

Top categories

Loading Svelte Themes