Skip to content

Update readme

Update readme #12

Workflow file for this run

name: Deploy to GitHub Pages
on:
push:
branches: ["master"]
# 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
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "16.x"
- name: Install Dependencies
run: npm install
- name: Build
run: npm run build
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v1
with:
# Path of the directory containing the static assets.
path: ./dist
# Duration after which artifact will expire in days.
retention-days: 1
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v1
id: deployment
with:
artifact_name: github-pages