Add CI/CD pipeline, fix all notebooks#71
Merged
Conversation
* Implement retry mechanism in download functions * Hardcode assets file paths * initial commit * add requirements.in * add postBuild * make package installable * update all `mirdotcom.init()` calls * add binder badge * try fix install * update all binder links * remove badges, update colab references * fix line break * add jupyter-book requirement * try refactor * update all headings * fix test paths * update cross-references * add initial jupyter-book build * try fix * remove musicinformationretrieval.com URLs and "Back to index" * update config to fix thebe + binder * update all notebooks * actually set working directory * replace references to "workshop" with "website" * fix sheet music representations links * fix midi conversion table * remove function names as section titles * axis labels * remove hardcoded ../../assets, replace with `mirdotcom.get_audio` * add beginner tutorial * move "people who use this site" section * add build target to makefile * pin dependencies, minor fixes * add note about .ipynb * optimize imports * remove "hide-cell" * fix titles * add more unittests for notebooks * make notebooks pass tests * add black formatting + deps: run `make fix` * run black on files
# Conflicts: # mirdotcom.py
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
1 participant
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.
This is a pretty big PR that aims to:
A good chunk of this is built on the work in #61 (thanks, @gijzelaerr!).
CI Pipeline
Tests are integrated into a single
Makefile. To run all tests, just runmake tests.These tests:
exercisenotebooks, which are designed to be filled in by the user.adtlib.ipynb, which is currently broken due totensorflowversions, and will need a complete rewrite (seeadtlibissues #70)The tests will also be run automatically on GitHub actions whenever a pull request is made or merged. They will also run once every week, which should help prevent issues with broken links accumulating over time.
Notebook modernisation
Fixes #66
With the CI pipeline, I've gone through and fixed up all notebooks so that they can be run with the requirements specified in
requirements.txt.Still TODO
Currently the GitHub actions runners seem a little flaky and prone to dying. We can try tweaking the number of times we rerun each notebook or reduce the number of workers to 1.