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

Test tutorials #386

Open
ElliottKasoar opened this issue Jan 17, 2025 · 2 comments
Open

Test tutorials #386

ElliottKasoar opened this issue Jan 17, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation priority Urgent attention required

Comments

@ElliottKasoar
Copy link
Member

From various discussions, my current intention is to migrate the tutorials in https://github.com/stfc/janus-tutorials into this repository, making them easier to find, and test against.

Exactly how/when we test them is still open to discussion. I don't think we want to test them on every change to main, but I'm currently thinking we ought to test that they run before each tagged release is generated and published.

@ElliottKasoar ElliottKasoar added documentation Improvements or additions to documentation priority Urgent attention required labels Jan 17, 2025
@ElliottKasoar ElliottKasoar self-assigned this Jan 17, 2025
@alinelena
Copy link
Member

I suggest we tested them on every tag, or manually

@ElliottKasoar
Copy link
Member Author

I suggest we tested them on every tag, or manually

Yes, that's sort of what I mean.

I'm just thinking it would be nice if it's tested before the tag is "finalised".

Currently, we run publish-on-pypi on tagging. I'm suggesting that as part of that workflow, or at least as a condition, we run tests on the tutorials.

If the tests fail, we'd have to delete the tag and try again, but it means our official tagged releases on GitHub/PyPI contain working tutorials for that tag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority Urgent attention required
Projects
None yet
Development

No branches or pull requests

2 participants