New action: Colab compatibility check for lecture notebooks

Abierto
  • ¿Algo no está bien?
#185 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
40/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
docker, github-actions, python
Área
ci-cd, developer-experience, testing

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Shell
Estrellas
0
Forks
1
Merge medio
18 h 51 min
PR fusionados (30 d)
58

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de QuantEcon/actions

Todos los issues de QuantEcon/actions

Issues similares

Más issues de Shell/Bash

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.