Publier une nouvelle version

Déploiement

Cette page est un rappel pour les mainteneurs sur la façon de déployer. Cette section n’est pertinente que lors de la publication d’une nouvelle version mineure de la librairie.

Avertissement

Il est important de savoir que toute modification des fichiers situés dans le dossier src/xhydro (à l’exception de src/xhydro/__init__.py) déclenchera le workflow bump-version.yml. Faites attention à ne pas commettre de modifications dans ces fichiers lors de la préparation d’une nouvelle version.

1. Créer une nouvelle branche depuis main (par exemple, release-0.2.0).

2. Mettre à jour le fichier CHANGELOG.rst pour changer la section Unreleased à la date actuelle.

3. Augmenter la version dans votre branche à la version suivante (par exemple, v0.1.0 -> v0.2.0) :

   bump-my-version bump minor # In most cases, we will be releasing a minor version
   bump-my-version bump release # This will update the version strings to drop the `dev` suffix
   git push origin release-0.2.0
   

4. Créer une pull request de votre branche vers main.

5. Une fois la pull request fusionnée, créer une nouvelle version sur GitHub. Sur la branche main, exécutez :

   git tag v0.2.0
   git push --tags
   

   Cela déclenchera un workflow GitHub pour construire la librairie et la télécharger sur TestPyPI. En même temps, le workflow GitHub créera une version brouillon sur GitHub. Si le workflow réussit, la version finale pourra être publiée sur GitHub en finalisant la version brouillon.

6. Pour générer les notes de version, exécutez :

   import xhydro.testing.utils as xhu
   
   print(xhu.publish_release_notes())
   

   Cela affichera les notes de version (tirées du fichier CHANGELOG.rst) dans votre console Python. Copiez-collez-les dans la description de la version sur GitHub, en ne conservant que les changements pour la version actuelle.

7. Une fois la version publiée, le workflow publish-pypi.yml passera en mode awaiting approval sur Github Actions. Seuls les utilisateurs autorisés pourront approuver ce workflow (des notifications seront envoyées) pour déclencher le téléchargement sur PyPI.

   Avertissement

   Les téléchargements vers PyPI ne peuvent jamais être écrasés. Si vous faites une erreur, vous devrez augmenter la version et republier la librairie. Si la librairie téléchargée sur PyPI est défectueuse, vous devez modifier la version sur GitHub pour marquer la librairie comme défectueuse, ainsi que retirer cette version (marquer la version « broken ») sur PyPI.

8. Une nouvelle version de xHydro sur PyPI déclenchera le regro-cf-autotick-bot pour ouvrir une pull request sur le dépôt conda-forge. Cela mettra automatiquement à jour le dépôt avec la nouvelle version de la librairie. Les mainteneurs du dépôt devront examiner et fusionner la pull request.