docs(packaging): remplacer les métadonnées fictives et réconcilier les promesses de CI #18

New Issue

AntoineVe · 2026-09-09T00:09:02+02:00

AntoineVe commented

2026-09-09 00:09:02 +02:00

Constat

Les métadonnées de distribution dans pyproject.toml sont encore des valeurs de gabarit :

auteur « Votre Nom » et adresse « votre@email.com » ;
quatre URLs GitHub sous github.com/votre-utilisateur/pronote-sync, alors que le projet vit sur Gitea ;
absence de champ readme malgré la présence de README.md.

Par ailleurs, le changelog 0.1.0 indique dans la même entrée qu'une référence Gitea Actions CI/CD fait partie de M15, puis qu'elle est seulement prévue et non livrée. TODO.md maintient l'automatisation comme optionnelle et aucun workflow Gitea n'est présent dans l'arborescence.

Ces éléments donnent aux utilisateurs de package et aux contributeurs des destinations ou promesses incompatibles.

Proposition

Choisir une politique de publication claire et la refléter dans les trois surfaces :

renseigner les métadonnées réelles du projet, ou retirer les métadonnées de distribution qui prétendent pointer vers un dépôt public ;
déclarer explicitement le README si le paquet est destiné à être distribué ;
soit livrer un workflow Gitea Actions correspondant aux outils annoncés, soit décrire la CI comme non disponible et renvoyer vers les commandes locales ;
corriger le changelog pour qu'il distingue ce qui est livré de ce qui est seulement envisagé.

Critères d'acceptation

Les URLs de métadonnées pointent toutes vers les surfaces réellement accessibles du projet.
Aucun placeholder d'auteur, d'email ou de forge ne subsiste dans les métadonnées publiées.
La page de paquet affiche le README voulu, ou le projet déclare explicitement ne pas viser cette distribution.
README, TODO et CHANGELOG donnent le même statut à la CI.
Si un workflow est ajouté, il exécute au minimum les vérifications annoncées ; sinon les procédures locales sont la seule promesse de validation.

Périmètre

Métadonnées de paquet, documentation et éventuellement CI déclarative ; pas de changement de comportement métier.

## Constat Les métadonnées de distribution dans `pyproject.toml` sont encore des valeurs de gabarit : - auteur « Votre Nom » et adresse « votre@email.com » ; - quatre URLs GitHub sous `github.com/votre-utilisateur/pronote-sync`, alors que le projet vit sur Gitea ; - absence de champ `readme` malgré la présence de `README.md`. Par ailleurs, le changelog `0.1.0` indique dans la même entrée qu'une référence Gitea Actions CI/CD fait partie de M15, puis qu'elle est seulement prévue et non livrée. `TODO.md` maintient l'automatisation comme optionnelle et aucun workflow Gitea n'est présent dans l'arborescence. Ces éléments donnent aux utilisateurs de package et aux contributeurs des destinations ou promesses incompatibles. ## Proposition Choisir une politique de publication claire et la refléter dans les trois surfaces : 1. renseigner les métadonnées réelles du projet, ou retirer les métadonnées de distribution qui prétendent pointer vers un dépôt public ; 2. déclarer explicitement le README si le paquet est destiné à être distribué ; 3. soit livrer un workflow Gitea Actions correspondant aux outils annoncés, soit décrire la CI comme non disponible et renvoyer vers les commandes locales ; 4. corriger le changelog pour qu'il distingue ce qui est livré de ce qui est seulement envisagé. ## Critères d'acceptation - Les URLs de métadonnées pointent toutes vers les surfaces réellement accessibles du projet. - Aucun placeholder d'auteur, d'email ou de forge ne subsiste dans les métadonnées publiées. - La page de paquet affiche le README voulu, ou le projet déclare explicitement ne pas viser cette distribution. - README, TODO et CHANGELOG donnent le même statut à la CI. - Si un workflow est ajouté, il exécute au minimum les vérifications annoncées ; sinon les procédures locales sont la seule promesse de validation. ## Périmètre Métadonnées de paquet, documentation et éventuellement CI déclarative ; pas de changement de comportement métier.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: AntoineVe/college-infos#18