search

ProjectPythia / cookbook-template

Project Pythia Cookbook template
https://projectpythia.org/cookbook-template/
Apache License 2.0
23 stars 17 forks source link

Add lots of actions for build, preview, and testing #4

Closed brian-rose closed 2 years ago

brian-rose commented 2 years ago

This incorporates all the automated actions I've been developing over at https://github.com/ProjectPythiaTutorials/radar-cookbook/issues/6

brian-rose commented 2 years ago

I think this is ready to do, but we won't be able to actually test the previewing capability until this gets merged. Functionality should be very similar to what you can see at the Radar Cookbook here: https://github.com/ProjectPythiaTutorials/radar-cookbook/pull/22

There are reusable actions for book building / uploading, and link-checking.

New PRs will cause the book to build, and a rendered preview to be hosted at _preview/[PR number/ relative to the main site. These PR previews remain visible until the PR is either closed or merged.

Meanwhile there is a nightly build that also builds the book and checks links.

The build_book.yaml and link-checker.yaml are written to be portable. They don't actually need to be deployed in each Cookbook repo. We can park them in any publicly visible GitHub repo (so long as the calls in trigger-book-build.yaml, nightly-build.yaml and deploy-book.yaml are updated with the correct path). The idea here is to cut down on maintenance going forward. In fact I'm going to propose updating Pythia Foundations to use some of these actions as well.

brian-rose commented 2 years ago

I think this is an elegant solution, because any Cookbook repo based on this template will have nearly instant previewing and testing capability without configuring any third-party services like netlify or readthedocs.

brian-rose commented 2 years ago

Also once this gets merged we'll be able to add current build status badges to the repo README and also embedded in the rendered Cookbook (if we want that!)

brian-rose commented 2 years ago

Closes #4

brian-rose commented 2 years ago

@mgrover1, great, thanks for the eyes on this. I'm going to merge now so we have a chance to properly test it out.