Skip to content

Update README.md

Update README.md #4

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static 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:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
# only checkout certain files
- name: Checkout files
uses: actions/checkout@v3
with:
ref: gh-pages
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install pip requirements
run: pip3 install -r requirements.txt
shell: sh
- name: Run generation script
run: python generate_index.py
shell: sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: './output'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2