Skip to content
This repository has been archived by the owner on Jul 1, 2022. It is now read-only.

Update notebooks based on successful CI runs #28

Open
fingolfin opened this issue Apr 22, 2020 · 2 comments
Open

Update notebooks based on successful CI runs #28

fingolfin opened this issue Apr 22, 2020 · 2 comments
Assignees

Comments

@fingolfin
Copy link
Member

We plan to provide (most/all?) of our examples as "static" notebooks which are pre-rendered, so people can easily view them. When we do that, it's annoying if the output in there does not match the current output -- e.g. if the OSCAR banner says "0.1" when the actual version is "0.5".

I am not actually sure what we test there right now: if the output differs, do we reject this as a test failure? Or do we just test that the example runs through and produces no error?

Regardless of that, we need an easy and quick way to update the notebooks with the "latest" outputs, and the logical thing to do here is to use the CI for this: i.e., as part of the CI, update the notebooks (either by pushing directly to their repos, or by opening PRs for them; both of these are not too hard to script)

@rbehrends
Copy link
Collaborator

We are currently strictly testing for errors occuring during tests, but don't compare output. Comparing them is not hard per se; I already render them to RST as a diff-friendly format, but we also need to have an easy way to update them if they change. I think the best way to go about that would be to put them in a separate repository, e.g. oscar-ci-data, which could also hold other such information.

@fingolfin
Copy link
Member Author

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants