Versions ultérieures
Ce guide explique comment publier de nouvelles versions de packages ROS qui ont déjà été publiés auparavant.
Table des matières
Faire partie de l’équipe de publication
Si vous ne faites pas partie de l’équipe de publication qui a un accès en écriture au référentiel de publication, suivez Rejoignez une équipe de publication.
Installer les dépendances
Installez les outils que vous utiliserez dans les prochaines étapes en fonction de votre plateforme :
sudo apt install python3-bloom python3-catkin-pkg
sudo dnf install python3-bloom python3-catkin_pkg
pip3 install -U bloom catkin_pkg
Configurer un jeton d’accès personnel
Avertissement
Si le fichier ~/.config/bloom
existe sur votre ordinateur, il est probable que vous l’ayez déjà fait auparavant, vous devriez donc ignorer cette section.
Au cours du processus de publication, plusieurs opérations HTTPS Git seront effectuées qui nécessitent une authentification par mot de passe. Pour éviter qu’on vous demande à plusieurs reprises un mot de passe, un Personal Access Token (PAT) sera configuré. Si vous avez configuré l’authentification multifacteur sur votre compte GitHub, vous devez configurer un jeton d’accès personnel.
Créez un jeton d’accès personnel en :
Connectez-vous à GitHub et accédez à Jetons d’accès personnels.
Cliquez sur le bouton Générer un nouveau jeton.
Définissez Remarque sur quelque chose comme
Bloom token
.Définissez Expiration sur Aucune expiration.
Cochez les cases
public_repo
etworkflow
.Cliquez sur le bouton Générer un jeton.
Après avoir créé le jeton, vous vous retrouverez sur la page Jetons d’accès personnels. Copiez le jeton alphanumérique surligné en vert.
Enregistrez votre nom d’utilisateur GitHub et votre PAT dans un nouveau fichier appelé ~/.config/bloom
, au format ci-dessous :
{
"github_user": "<your-github-username>",
"oauth_token": "<token-you-created-for-bloom>"
}
Assurez-vous que les référentiels sont à jour
Sois sûr que:
Votre référentiel est hébergé sur une télécommande telle que GitHub.
Vous avez un clone du référentiel sur votre ordinateur et vous êtes sur la bonne branche.
Le référentiel distant et votre clone sont à jour.
Mise à jour du journal des modifications
Pour vos utilisateurs et pour les développeurs, gardez le changelog concis et à jour.
catkin_generate_changelog
Ouvrez tous les fichiers CHANGELOG.rst
dans un éditeur. Vous verrez que catkin_generate_changelog
a généré automatiquement une section à venir avec des notes de messages de validation :
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changelog for package your_package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Forthcoming
-----------
* you can modify this commit message
* and this
Nettoyez la liste des messages de validation pour transmettre de manière concise les changements notables qui ont été apportés aux packages depuis la dernière version, et commettez tous les fichiers CHANGELOG.rst. Ne modifiez pas l’en-tête Forthcoming
.
Bump la version du package
Chaque version du package doit avoir un numéro de version unique supérieur à celui de la version précédente. Courir:
catkin_prepare_release
qui effectue les opérations suivantes :
augmente la version du paquet dans
package.xml
remplace le titre
À venir
parversion (date)
(ex.0.0.1 (2022-01-08)
) dansCHANGELOG.rst
valide ces changements
crée une balise (ex.
0.0.1
)pousse les modifications et la balise vers votre référentiel distant
Note
Par défaut, la version du correctif du paquet est incrémentée, par exemple de 0.0.0
à 0.0.1
. Pour incrémenter la version mineure ou majeure à la place, exécutez catkin_prepare_release --bump minor
ou catkin_prepare_release --bump major
. Pour plus de détails, voir catkin_prepare_release --help
.
Libération de la floraison
Exécutez la commande suivante en remplaçant my_repo
par le nom de votre référentiel avec les packages :
bloom-release --rosdistro rolling my_repo
Bloom créera automatiquement une pull request pour vous contre rosdistro.
Prochaines étapes
Une fois votre demande de tirage soumise, généralement dans un délai d’un ou deux jours, l’un des responsables de rosdistro examinera et fusionnera votre demande de tirage. Si la construction de votre package réussit, vos packages seront disponibles dans les 24 à 48 heures dans le référentiel ros-testing, où vous pourrez tester vos binaires de pré-version.
Environ toutes les deux à quatre semaines, le gestionnaire de publication de la distribution synchronise manuellement le contenu de ros-testing dans le référentiel ROS principal. C’est à ce moment que vos packages deviennent réellement disponibles pour le reste de la communauté ROS. Pour obtenir des mises à jour sur la date de la prochaine synchronisation (sync), abonnez-vous à la catégorie Packaging and Release Management Category on ROS Discourse.