Skip to content

660 ci exercise tutorial notebooks#674

Merged
cpaniaguam merged 44 commits intomainfrom
660-ci-exercise-tutorial-notebooks
Mar 20, 2025
Merged

660 ci exercise tutorial notebooks#674
cpaniaguam merged 44 commits intomainfrom
660-ci-exercise-tutorial-notebooks

Conversation

@cpaniaguam
Copy link
Copy Markdown
Collaborator

@cpaniaguam cpaniaguam commented Feb 27, 2025

This pull request introduces a new GitHub workflow for checking Jupyter notebooks and updates the development dependencies in the pyproject.toml file. The most important changes are:

Workflow Enhancements:

  • Added a new GitHub Actions workflow to check notebooks on pull requests and workflow calls. This workflow includes steps to set up the environment, check out the repository, and run tests on the notebooks.

Dependency Updates:

  • Updated the pyproject.toml file to include nbval as a development dependency, which is necessary for validating Jupyter notebooks.

Note

Currently there are changes (deletions) to notebook outputs and metadata. If there is interest in keeping cell output, the corresponding commit can be reverted and apply #675 instead.

@cpaniaguam cpaniaguam added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 27, 2025
@cpaniaguam cpaniaguam self-assigned this Feb 27, 2025
@cpaniaguam cpaniaguam linked an issue Feb 27, 2025 that may be closed by this pull request
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@cpaniaguam cpaniaguam marked this pull request as ready for review February 28, 2025 19:05
Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cpaniaguam don't fully get what's happening with the deletions in the notebooks here.

Let's discuss tomorrow during checkin meeting, I think I just don't grasp fully what the PR accomplishes.

@AlexanderFengler
Copy link
Copy Markdown
Member

@cpaniaguam the other PR drops the meta data, this one looks more like it's dropping all output? Can you clarify?

Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remaining slightly confused let's talk about this quickly.

@cpaniaguam cpaniaguam force-pushed the 660-ci-exercise-tutorial-notebooks branch from af4ee0e to a4451aa Compare March 11, 2025 13:37
Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a few questions.

},
{
"cell_type": "code",
"execution_count": null,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the idea to drop the execution count again?

{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idea to drop the execution count again, or fine as is?

@@ -0,0 +1,41 @@
name: Check notebooks

on:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want this upon every pull_request?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it wouldn't hurt.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just for the record, we decided to move forward with running this manually and upon building docs upon release.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I'll update this shortly.

@cpaniaguam cpaniaguam force-pushed the 660-ci-exercise-tutorial-notebooks branch from e7365a6 to 6520fb0 Compare March 17, 2025 17:08
@cpaniaguam
Copy link
Copy Markdown
Collaborator Author

@AlexanderFengler One of the tutorials has a problem. I documented it in #688.

@AlexanderFengler
Copy link
Copy Markdown
Member

@AlexanderFengler One of the tutorials has a problem. I documented it in #688.

Ok we fix that issue before merging this one then correct?

@cpaniaguam
Copy link
Copy Markdown
Collaborator Author

@AlexanderFengler One of the tutorials has a problem. I documented it in #688.

Ok we fix that issue before merging this one then correct?

Not necessarily. I think the two are independent.

Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I think this is good to merge now! Thanks @cpaniaguam.
We can deal with emerging issues on this front and make sure the docs are pristine again for the next release :).

@cpaniaguam cpaniaguam merged commit c03a1af into main Mar 20, 2025
5 checks passed
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CI: exercise tutorial notebooks

2 participants