ci: exclude tutorial notebooks from detect-secrets#1
Merged
Merged
Conversation
Matplotlib PNG outputs embedded in tutorial notebooks trigger Base64HighEntropyString false positives. Outputs change on every re-run, making baseline maintenance impractical. Tutorials are intentionally shipped with rendered outputs for Colab/Sphinx.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
The docs workflow was installing .[dev] but not .[docs], so myst-parser, furo, nbsphinx, etc. were missing at build time. Also drops the manual sphinx/sphinx-rtd-theme install — sphinx is already in the [docs] extra and sphinx-rtd-theme was unused (theme is furo).
nbsphinx converts .ipynb → HTML via pandoc, which is a system binary not a pip package. ReadTheDocs had this fix already (9e1b285) but the GH Actions docs workflow needed it too.
Notebook code cells are tagged with language 'ipython3', which requires the IPython package to register the matching Pygments lexer. Without it, sphinx-build -W fails on the highlighting warning.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/tutorials/*.ipynbfrom the detect-secrets pre-commit hook.Base64HighEntropyStringfalse positives and change on every re-run, making baseline maintenance impractical.Test plan
pre-commit run detect-secrets --all-filespasses locallytest.ymlpasses on the PR