Python version policy: test all supported versions and update once a year

Aperta
  • Qualcosa non va?
#189 0 commenti 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
54/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, github-actions, python
Ambito
ci-cd, devops

Direzione di ricerca

Start with HOWTOCONTRIBUTE.md and doc/ARCHITECTURE.md to define the yearly Python support policy, then inspect the CI workflow matrix and the README, Dockerfile, .devcontainer/devcontainer.json, and Update_Examples_Gallery.yml version settings. Check dependency support for Python 3.11–3.15 and document any version left out of CI. Done when the policy is documented, the recommended version is applied to the listed files, and CI passes across the supported matrix.

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

Descrizione

announce enhancement good first issue

Part of #131.

Problem

CI tests only Python 3.13, and the README, the Dockerfile and the gallery workflow all use 3.13. There is no rule for when to move to a newer version or which versions are supported.

  • Users run different versions (for example 3.10 on Ubuntu 22.04 and 3.12 on Ubuntu 24.04), but only one is tested
  • The library release (#172) needs to declare requires-python
  • The Dockerfile is pinned to python:3.13.0, so it doesn't get the bug and security fixes of later 3.13.x releases

Expected change

  1. Write the policy in HOWTOCONTRIBUTE.md (and refer to it from doc/ARCHITECTURE.md):
    • Supported versions: every Python version that hasn't reached its end of life. CI tests all of them
    • Recommended version: the newest version minus one. The README, the Dockerfile, the devcontainer and the gallery workflow use it. The newest version is not recommended right after its release, because the dependencies (numpy, scipy, matplotlib, casadi, do-mpc) may not have wheels for it yet
    • Yearly review in December or January, after the October release of Python: add the new version to CI once the dependencies support it, move the recommended version up by one, and drop versions that reached their end of life
  2. Apply it for this year:
    • CI matrix (Linux, macOS, Windows): 3.11 to 3.15. A version that a dependency doesn't support yet stays out of the matrix, with a comment saying why
    • Recommended version: 3.14 in the README, Dockerfile (python:3.14, without a patch number), .devcontainer/devcontainer.json and Update_Examples_Gallery.yml

Done when

  • The policy is in HOWTOCONTRIBUTE.md
  • CI passes on every supported version in the matrix
  • The README, the Dockerfile, the devcontainer and the gallery workflow use the recommended version

Related: #172 (requires-python of the package), #165 (book versions follow the same yearly cycle).

Lingua principale
Python
Stelle
1.9k
Fork
313
Merge medio
1g 7h
PR unite (30g)
21

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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 ShisatoYano/AutonomousVehicleControlBeginnersGuide

Tutte le issue di ShisatoYano/AutonomousVehicleControlBeginnersGuide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.