Processus de publication d'AllenNLP sur GitHub et PyPI
Ce document décrit la procédure de publication des nouvelles versions de la bibliothèque principale.
Cela suppose que vous utilisez un clone du dépôt principal avec l'origine distante pointée vers git@github.com:allenai/allennlp.git (ou son équivalent HTTPS).
Étapes
Définissez la variable d'environnement TAG, qui doit être de la forme v{VERSION}.
Par exemple, si la version est 1.0.0, définissez TAG sur v1.0.0 :
| export TAG='v1.0.0' |
Ou si vous utilisez du poisson :
| set -x TAG 'v1.0.0' |
Mettez à jour allennlp/version.py avec la bonne version. Vérifiez ensuite le résultat de :
| python scripts/get_version.py current |
Correspond à la variable d'environnement TAG.
Mettez à jour le fichier CHANGELOG.md afin que tous les éléments de la section «Non publié» soient désormais classés dans une section correspondant à cette version.
Mettez à jour le fichier CITATION.cff pour qu'il fasse référence à la bonne version.
Commitez et envoyez ces modifications avec :
| git commit -a -m "Prepare for release $TAG" && git push |
Ajoutez ensuite la balise dans git pour marquer la version :
| git tag $TAG -m "Release $TAG" && git push --tags |
Recherchez la balise que vous venez de pousser sur GitHub, cliquez sur Modifier, puis copiez la sortie de :
| python scripts/release_notes.py |
Sur un Mac, par exemple, vous pouvez simplement envoyer la commande ci-dessus à pbcopy.
Cochez la case «Ceci est une pré-version» si la version est une version candidate (se terminant par rc*). Sinon, laissez-la décochée.
Cliquez sur « Publier la version ». GitHub Actions se chargera ensuite du reste, y compris la publication du paquet sur PyPI et de l'image Docker sur Docker Hub.
Une fois le flux de travail GitHub Actions terminé, suivez la même procédure pour publier une version pour le dépôt allennlp-models.
Correction d'une version échouée
Si, pour une raison quelconque, le flux de travaux GitHub Actions a échoué avec une erreur nécessitant une correction, vous devrez supprimer la balise et la version correspondante de GitHub. Après avoir déployé un correctif, supprimez la balise de votre clone local avec :
| git tag -l | xargs git tag -d && git fetch -t |
Répétez ensuite les étapes ci-dessus.