Update tests to ignore Markdown, RST and template and landing page notebooks #1194
Conversation
robbibt
requested review from
BexDunn,
erialC-P,
uchchwhash,
Kooie-cate,
geoscience-aman,
JM-GA,
margaretharrison,
vnewey,
Ariana-B,
amanda2099,
supermarkion and
erin-telfer
as code owners
robbibt
changed the title
| - 'DEA_Sandbox.ipynb' # ignore landing page | ||
| - 'DEA_notebooks_template.ipynb' # ignore template | ||
| - '*.md' # ignore all markdown files | ||
| - '*.rst' # ignore all restructured text files |
There was a problem hiding this comment.
I think that this **/* syntax is needed to ignore all of them recursively, not just in the root directory.
- '**/*.md' # ignore markdown files
- '**/*.rst' # ignore restructured text filesThere was a problem hiding this comment.
I don't think the recursive ignore was ignoring the top level markdown files in your previous PR - it seemed to be only catching the ones nested within subfolders.
We could leave the recursive ignore as it is though and adding in your suggested top level "*" ignore to catch the Readme?
There was a problem hiding this comment.
Actually, maybe it just needs to be "**.md?" to catch both top level and nested files?
https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#patterns-to-match-file-paths
| - '.github/**' # ignore anything in .github folder | ||
| - '!.github/workflows/test_notebooks.yml' # except test_notebooks.yml | ||
| pull_request: | ||
| branches: [ develop, stable ] | ||
| paths-ignore: | ||
| - '**/*.md' | ||
| - '**/*.rst' | ||
| - 'DEA_Sandbox.ipynb' |
There was a problem hiding this comment.
Are you sure this should be ignored? It is a Notebook file that we need to check renders properly on the Sandbox.
There was a problem hiding this comment.
It doesn't actually include any code - it's all entirely pre-rendered markdown cells so there's not anything for pytest to run to test for a pass/fail.
| - 'DEA_Sandbox.ipynb' | ||
| - 'DEA_notebooks_template.ipynb' | ||
| - '*.md' | ||
| - '*.rst' | ||
| - '.github/**' | ||
| - '!.github/workflows/test_notebooks.yml' |
There was a problem hiding this comment.
Maybe we should ignore everything in the root directory except for Notebook files:
- '*'
- '!*.ipynb'There was a problem hiding this comment.
I'd be happy to ignore all top-level files - the two notebooks there are either entirely Markdown or are not intended to be run by our users (both aren't included in our test coverage anyway, and DEA_notebooks_template.ipynb isn't even synced to the Sandbox).
There was a problem hiding this comment.
I agree. Sounds good.
Proposed changes
This PR updates the "ignore-paths" line of our Github Actions testing workflow to ignore future updates to the repo's Readme, template notebook or landing page notebook.
This will prevent us having to wait ~30 minutes for tests to run after making minor updates to Markdown or RST files.