New action: Colab compatibility check for lecture notebooks

Aperta
  • Qualcosa non va?
#185 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
40/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
docker, github-actions, python
Ambito
ci-cd, developer-experience, testing

Direzione di ricerca

Start by reading the existing collab.yml workflow in the lecture-python.myst repository to understand the current check. Review docs/dev/PLAN.md for the architectural decision about standalone workflows. The action would need to run notebooks in the Colab runtime image and report failures. Design inputs for the action and consider how to handle Colab's changing :latest image.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

infrastructure

Why

Readers open the lectures in Google Colab through the theme's launch links, so a lecture that fails in Colab's environment fails for them. Only lecture-python.myst checks this today, with its own collab.yml. The idea was recorded in docs/FUTURE-DEVELOPMENT.md, which #178 removed (source).

Proposal

A reusable action that:

  • runs the notebooks inside us-docker.pkg.dev/colab-images/public/runtime:latest;
  • checks execution against Colab's Python and package versions;
  • opens a deduplicated issue on failure.

Needs deciding first

  • PLAN records the opposite. docs/dev/PLAN.md lists "collab.yml and linkcheck.yml remain standalone workflows" among its settled architectural decisions. Building this action means revisiting that decision, so settle that before building anything.
  • Demand. Check which other lecture repos would adopt it. The original note said it could help other repos, but only one repo runs the check today.
  • Unpinned image. Colab's runtime image is :latest and changes outside our control. Decide how a failure caused by a Colab update, rather than a lecture change, should be reported.

Checklist

  • Revisit the "collab.yml remains standalone" decision in docs/dev/PLAN.md
  • Read lecture-python.myst's collab.yml for what it does today
  • If going ahead: design the inputs, and write the action, harness coverage and a manual chapter
Lingua principale
Shell
Stelle
0
Fork
1
Merge medio
20h 3m
PR unite (30g)
48

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di QuantEcon/actions

Tutte le issue di QuantEcon/actions

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.