search

Mach30 / dof

Distributed OSHW Framework - A methodology for documenting and sharing Open Source Hardware
https://mach30.github.io/dof/
Creative Commons Attribution 4.0 International
8 stars 4 forks source link

setup pipeline for deploying to gh-pages #8

Closed capsulecorplab closed 3 years ago

capsulecorplab commented 3 years ago

Workflow

Pushing to deploy branch will trigger GitHub Actions to run the build.sh script and publish output (contents of public/) to GitHub Pages. (See github/workflows/deploy.yml for details)

Note: publish_dir (in github/workflows/deploy.yml) will need to be changed to master, if you later decide to migrate the static site to a user/organization page. See https://stackoverflow.com/questions/25559292/github-page-shows-master-branch-not-gh-pages

Configuration

You will need to generate a public and private ssh key, then add them to Deploy keys and Secrets, respectively, in the GitHub repo settings. Follow instructions in https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-create-ssh-deploy-key

Preview

Site preview available on https://capsulecorplab.github.io/dof/