afsc-assessments / sop

https://afsc-assessments.github.io/sop/
1 stars 1 forks source link

Automate rendering of bookdown for github site #4

Open JaneSullivan-NOAA opened 2 years ago

JaneSullivan-NOAA commented 2 years ago

Info from Kathryn Doering: You can copy the workflow from the FIMS collaborative workflow repo into a .github/workflows folder of your repository: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms . By default, this workflow renders the bookdown on every push to the repository.

This workflow assumes that the bookdown output is rendered to a docs/ subfolder and then pushed to a branch called gh-pages (e.g., https://github.com/NOAA-FIMS/collaborative_workflow/tree/gh-pages). If github pages isn't already set up, you will need to change the branch for the publishing source, as in these instructions: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source