Add Google Colab compatibility and update CI/CD workflow - #6
Open
yohanchatelain wants to merge 8 commits into
Open
yohanchatelain wants to merge 8 commits into
yohanchatelain wants to merge 8 commits into
Conversation
Verificarlo 2.5.0 dropped support for LLVM < 17, so the setup cell's hardcoded llvm-14-dev/clang-14 install can no longer build it. Update the install cell to: - pick the newest supported LLVM (17-21) available in apt, falling back to apt.llvm.org when none is packaged (e.g. older Colab images) - install the newly required build dependencies: GNU parallel and libclang-rt-dev All other tutorial interfaces (MCA/IEEE/VPREC backends and options, --ddebug/--inst-fma flags, vfc_ddebug, VFC_BACKENDS_LOGGER) are unchanged in verificarlo 2.5.1. Notebook outputs regenerated by a full end-to-end run against verificarlo 2.5.1 built with LLVM 20 on Ubuntu 24.04. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ao48deGgH1zfbPB2PLkqJ5
The workflow failed before running any step because actions/upload-artifact@v3 was disabled by GitHub in 2025. Update all actions to maintained versions: - actions/checkout v2 -> v4, actions/upload-artifact v3 -> v4 - dante-ev/latex-action@latest -> xu-cheng/latex-action@v3, passing the equivalent latexmk arguments Add a test_notebook job that executes tutorial.ipynb end-to-end inside the official verificarlo/verificarlo Docker image and uploads the executed notebook as an artifact, so the tutorial is checked against the latest verificarlo release on every push. Add an Open-in-Colab badge to the README and to the notebook title cell. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ao48deGgH1zfbPB2PLkqJ5
…-compat-ishw8x Update CI/CD workflow and improve project documentation
There was a problem hiding this comment.
Pull request overview
This pull request modernizes CI for building the LaTeX tutorial and adds CI execution of the Jupyter notebook, alongside small documentation and ignore-list updates to support Google Colab usage.
Changes:
- Updated the LaTeX build job to use newer GitHub Actions (checkout v4, latex-action v3, upload-artifact v4).
- Added a
test_notebookworkflow job that installs dependencies, executestutorial.ipynb, and uploads the executed notebook. - Added a Colab badge + notebook mention in
README.md, and expanded.gitignorefor LaTeX build artifacts.
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds a Colab badge and documents the notebook as part of the repo contents. |
| .gitignore | Ignores common LaTeX build outputs (aux/log/pdf/etc.). |
| .github/workflows/main.yml | Updates CI actions, adds a notebook execution job, and uploads notebook output as an artifact. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
- Dockerfile with LLVM 20, Verificarlo from source, and all dependencies - .dockerignore to exclude build artifacts and unnecessary files - docker-compose.yml for easy container management Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
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
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 pull request updates the CI workflow to use newer and more reliable GitHub Actions, introduces automated testing for the Jupyter notebook, and improves project documentation. The most significant changes are grouped below.
CI Workflow Updates:
actions/checkout@v4,xu-cheng/latex-action@v3(replacingdante-ev/latex-action), andactions/upload-artifact@v4for improved reliability and compatibility. [1] [2]Jupyter Notebook Testing:
test_notebookjob to the workflow that runs inside theverificarlo/verificarlo:latestcontainer, installs notebook dependencies, executestutorial.ipynb, and uploads the executed notebook as an artifact. This ensures the notebook runs successfully in CI.Documentation Improvements:
README.mdto include a Colab badge for easy access to the notebook and described the contents of the repository, highlighting the Jupyter notebook.