search

carpentries / workbench

Repository for Discussions and Materials about The Carpentries Workbench
https://carpentries.github.io/workbench/
Creative Commons Attribution 4.0 International
17 stars 7 forks source link

Document how instructors can teach from forks #37

Open zkamvar opened 1 year ago

zkamvar commented 1 year ago

One common pattern of use for lessons was the ability to fork the lesson, modify it, and teach from the fork.

I was given a report of someone who attempted this, but had trouble with GitHub actions. It turns out that GitHub actions does not enable workflows to run by default in forks. The user must

  1. enable workflows to run and then,
  2. once the workflows create a gh-pages branch, they must direct the pages to build from that branch. (this is partially explained in the first chapter of the documentation, but it could be expanded)
zkamvar commented 1 year ago

Note, I've added a section in the previous dovetail blog post for this: https://carpentries.org/blog/2023/01/dovetail-14/#tips-and-tricks-for-using-the-workbench

twrightsman commented 1 year ago

To point 1, I had to globally enable workflows for the fork and then had to enable the build and deploy scheduled workflow individually as well. I then had to run build and deploy manually once if I hadn't committed anything to the fork yet.