Skip to content

Commit

Permalink
fixup! guides: batch dependency update
Browse files Browse the repository at this point in the history
  • Loading branch information
Baptiste Prevot authored and Castavo committed Nov 21, 2023
1 parent 5904229 commit f82e088
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: "Batch dependency updates"
linkTitle: "Batch dependency updates"
weight: 20
description: ""
---


Expand All @@ -13,11 +12,10 @@ We use dependabot on the project to signal when dependencies are outdated. We do
Here is the process to update dependencies:

1. Change the versions.
* *If you're using VSCode* you can install the `crates` extension and run the "update all dependencies" command.
Doing so will update all dependencies to their latest version, and overwrite voluntarily loose version constraints.
* *If you're using VSCode* you can install the [`serayuzgur.crates`](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates) extension and run the "update all dependencies" command.
Make sure that the new version chosen is stable, and that loose constraints are not overwritten in your commit.
* *If you're not*, you can go check the versions used by dependabot in [its PRs](https://github.com/osrd-project/osrd/lls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) and update the versions manually.
* *If you're not*, you can go check the versions used by dependabot in [its PRs](https://github.com/osrd-project/osrd/pulls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) and update the versions manually.
2. Run `cargo update` to update the Cargo.lock file (even sub-dependencies).
3. Check that all [dependabot editoast PRs](https://github.com/osrd-project/osrd/lls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) are included in your update.
3. Check that all [dependabot editoast PRs](https://github.com/osrd-project/osrd/pulls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) are included in your update.
4. Adapt the code to the new versions, if needed.
5. Create a PR with your changes, and link all dependabot PRs in the description.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: "Mise à jour groupée des dépendances"
linkTitle: "Mise à jour groupée des dépendances"
weight: 20
description: ""
---


Expand All @@ -13,11 +12,11 @@ Nous utilisons dependabot sur le projet pour signaler quand les dépendances son
Pour mettre à jour les dépendances :

1. Changez les versions.
* *Si vous utilisez VSCode* vous pouvez installer l'extension `crates` et exécuter la commande "update all dependencies".
* *Si vous utilisez VSCode* vous pouvez installer l'extension [`serayuzgur.crates`](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates) et exécuter la commande "update all dependencies".
Cela mettra à jour toutes les dépendances vers leur dernière version, et écrasera les contraintes de version trop larges.
Assurez-vous que la nouvelle version choisie est stable, et que les contraintes volontairement larges ne sont pas écrasées par votre commit.
* *Sinon* vous pouvez vérifier les versions utilisées par dependabot dans [ses PRs](https://github.com/osrd-project/osrd/lls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) et mettre à jour les versions manuellement.
* *Sinon* vous pouvez vérifier les versions utilisées par dependabot dans [ses PRs](https://github.com/osrd-project/osrd/pulls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) et mettre à jour les versions manuellement.
2. Exécutez `cargo update` pour mettre à jour le fichier Cargo.lock (y compris les sous-dépendances).
3. Vérifiez que tous les [PRs dependabot editoast](https://github.com/osrd-project/osrd/lls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) sont inclus dans votre commit.
3. Vérifiez que tous les [PRs dependabot editoast](https://github.com/osrd-project/osrd/pulls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) sont inclus dans votre commit.
4. Adaptez le code aux nouvelles versions, si nécessaire.
5. Créez un PR avec vos modifications, et reliez-y tous les PRs dependabot en description.

0 comments on commit f82e088

Please sign in to comment.