Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example gallery to CI pipeline #37

Open
3 tasks
Pennycook opened this issue Apr 5, 2024 · 1 comment · May be fixed by #57
Open
3 tasks

Add example gallery to CI pipeline #37

Pennycook opened this issue Apr 5, 2024 · 1 comment · May be fixed by #57
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@Pennycook
Copy link
Contributor

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 Pennycook added enhancement New feature or request help wanted Extra attention is needed labels Apr 5, 2024
@Pennycook Pennycook added this to the 1.0.0 milestone Jul 18, 2024
@Pennycook
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant