berkeley-cdss / berkeley-class-site

A template for Berkeley CS and Data Science Classes
https://berkeley-cdss.github.io/berkeley-class-site/
MIT License
4 stars 4 forks source link

Setup GitHub Pages deployment without using github-pages gem #26

Closed phrdang closed 2 months ago

phrdang commented 2 months ago

As of #20 , the github-pages gem has been removed from the Gemfile list of dependencies, which is good because this allows us to use custom plugins and plugins that are not whitelisted by the github-pages gem.

However this means we need to figure out how we are going to deploy the site without using the nice GitHub Pages/Jekyll integration. From preliminary research, it seems the way to do this is to check into git the _site directory and deploy the html generated there, but the repository needs to be configured as does the CI workflow (jekyll.yml may not work anymore).

Potential resources to look into:

cycomachead commented 2 months ago

AFAIK, the default pages deploy workflow file works just fine to do the deployment. It seems to be work already. :)

The jekyll.yml still builds the site and was generated by GitHub.

https://github.com/berkeley-eecs/berkeley-class-site/blob/main/.github/workflows/jekyll.yml https://berkeley-eecs.github.io/berkeley-class-site/

Maybe we should edit the readme incase folks find the public site.

cycomachead commented 2 months ago

You can also verify here that thing work: https://github.com/berkeley-eecs/berkeley-class-site/deployments/github-pages

phrdang commented 2 months ago

Oh lol thanks for the catch, I just assumed it wouldn't work because of the jekyll plugin docs. I'll close this issue then!