Add example gallery to CI pipeline - Githubissues

intel / p3-analysis-library

A library simplifying the collection and interpretation of P3 data.

https://intel.github.io/p3-analysis-library/

MIT License

7 stars 10 forks source link

Add example gallery to CI pipeline #37

Closed Pennycook closed 3 weeks ago

Pennycook commented 5 months ago

Feature/behavior summary

We should explore the possibility of using GitHub actions to validate that changes do not break the example gallery.

Request attributes

[ ] Would this be a refactor of existing code?
[ ] Does this proposal require new package dependencies?
[ ] Would this change break backwards compatibility?

Related issues

No response

Solution description

Create a new GitHub action that does the following:

Run each of the examples and case-studies from the examples/ and case-studies/ directories.
Extract the images produced.
Attach the images to the workflow result as artifacts.

The action should pass as long as the examples execute correctly. We would still have to check the artifacts by eye.

Additional notes

No response

Pennycook commented 1 month ago

I'm setting this as required for 1.0.0 because I just found a few bugs when trying to re-generate the example gallery.