Update to gh actions page build #446
Conversation
sneakers-the-rat
requested review from
lwasser,
willingc and
kierisi
as code owners
There was a problem hiding this comment.
@sneakers-the-rat this is a huge improvement in our build. ive been doing things the same way for a long time and it's really cool to see the "in place // quiet" improvements here.
thank you so so much. i'm merging now but i left a few questions (just so i fully understand!).
| on: | ||
| # Runs on pushes targeting the default branch | ||
| push: | ||
| branches: [$default-branch] |
There was a problem hiding this comment.
@sneakers-the-rat i didn't know there was a $default-branch variable for actions. gosh that would have saved me a lot of time when we did the updates master --> main branch forever ago.
There was a problem hiding this comment.
Wait actually idk if this works lmao I think that might need to be a literal, but the sample action had this in it
There was a problem hiding this comment.
😆 so i'm not sure it does?? https://github.com/pyOpenSci/pyopensci.github.io/actions/workflows/gh-pages.yml
when i look at that this build after directly commiting a small change to main 🙈 it wasn't triggered
but what did get triggered is this action
could that be because i have github pages "turned on " in the repo settings somewhere? it's odd because the "pages" tab says this:
There was a problem hiding this comment.
oh yes - sorry, so yeah that should be replaced by main, and then you go to the pages setting and switch it from "deploy from branch" to "github action" . we just did this switch for our lab website and after that it worked without fuss
| @@ -0,0 +1 @@ | |||
| 3.3.3 | |||
There was a problem hiding this comment.
I also didn't know you could pin the ruby version. gosh learning so much.
| gem "jekyll-include-cache" | ||
| gem "webrick" | ||
| gem "html-proofer" | ||
| gem "ffi", "= 1.16.3" | ||
|
|
||
| gem "jekyll", "~>4.3.3" |
There was a problem hiding this comment.
@sneakers-the-rat i am going to merge this but i have a question.
You may have said this in the pr header but i want to be clear about what this does!
Is going this route going to allow us to avoid that github pages restriction of using other jekyll plugins and gems if we can also write our own? I just know that for a while that has also been a constraint for the site.
There was a problem hiding this comment.
Yep! We can add whatever gems we want here
| @@ -217,6 +217,7 @@ kramdown: | |||
| sass: | |||
| sass_dir: _sass | |||
| style: compressed # http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style | |||
There was a problem hiding this comment.
Gosh does this automagically minify the css?!
There was a problem hiding this comment.
as much as css can be minified! (it doesn't eg. simplify rules afaik, and you can't do the javascript thing of replacing all names with single characters, yes it does remove as much as it can https://sass-lang.com/documentation/cli/dart-sass/#style )
Currently the site is built with the old style github pages implicit jekyll build using the
github-pagesgem.Github has been moving away from this mode of doing github pages, and i believe is encouraging people to use the github actions style build anyway. This gives us full control over the build process, where the
github-pagesgem style build restricts us to certain whitelisted packages.In particular, we want to be able to write custom plugins for the build process that allow us to do stuff like generate badge images for every page depending on their review status as per this discussion: pyOpenSci/software-peer-review#293 (comment)
This should be a function-neutral PR, I just took the example workflow from here: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
and I set us up to use the most recent version of jekyll and ruby (i guess
3.3.4got released a few days ago). It looks like we have vendored in all the minimal mistakes code and aren't even using that as a theme anymore, correct? so I didn't add it as a dependency.