Skip to content

Commit 6b9188e

Browse files
committed
doc: move dependencies bump batching in general principles
Details for editoast are moved close to the code, in osrd/editoast/README.md
1 parent 165a3c3 commit 6b9188e

File tree

4 files changed

+5
-31
lines changed

4 files changed

+5
-31
lines changed

content/docs/guides/contribute/contribute-code/general-principles.en.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ description: "Please read this first!"
1313
- Avoid non well-known abbreviations.
1414
- **Control and consistency over 3rd party code reuse**: Only add a dependency if it is absolutely necessary.
1515
- Every dependency we add decreases our autonomy and consistency.
16+
- We try to keep PRs bumping dependencies to a low number each week in each component, so grouping
17+
dependency bumps in a batch PR is a valid option (see component's `README.md`).
1618
- **Don't reinvent every wheel**: as a counter to the previous point, don't reinvent everything at all costs.
1719
- If there is a dependency in the ecosystem that is the "de facto" standard, we should heavily consider using it.
1820
- More code general recommendations in main repository [CONTRIBUTING.md](https://github.com/osrd-project/osrd/blob/dev/CONTRIBUTING.md).

content/docs/guides/contribute/contribute-code/general-principles.fr.md

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ description: "À lire en premier !"
1313
- Évitez les abréviations peu connues.
1414
- **Contrôle et cohérence de la réutilisation du code de tiers** : une dépendance est ajoutée seulement si elle est absolument nécessaire.
1515
- Chaque dépendance ajoutée diminue notre autonomie et notre cohérence.
16+
- Nous essayons de limiter à un petit nombre les PRs de mise à jour des dépendances chaque semaine
17+
dans chaque composant, donc regrouper les montées de version dans une même PR est une bonne option
18+
(reportez-vous au `README.md` de chaque composant).
1619
- **Ne pas réinventer la roue** : en opposition au point précédent, ne réinventez pas tout à tout prix.
1720
- S'il existe une dépendance dans l'écosystème qui est le standard « de facto », nous devrions fortement envisager de l'utiliser.
1821
- Plus de code et de recommandations générales dans le dépôt principal [CONTRIBUTING.md](https://github.com/osrd-project/osrd/blob/dev/CONTRIBUTING.md).

content/docs/guides/contribute/license-and-set-up.en.md

-15
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,3 @@ Thanks to `docker`, one can easily compile, configure, and run all services afte
3838
[^docker-desktop]: Under Windows/[WSL](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers), [Docker Desktop](https://www.docker.com/products/docker-desktop/) is recommended
3939

4040
*[Continue towards code contribution ‣]({{< ref "contribute-code">}})*
41-
42-
#### `editoast` specific: batch dependency updates
43-
44-
We use dependabot on the project to signal when dependencies are outdated. We do not use dependabot to automatically update dependencies, as we want to merge all updates at once and review the changes.
45-
46-
Here is the process to update dependencies:
47-
48-
1. Change the versions.
49-
* *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.
50-
Make sure that the new version chosen is stable, and that loose constraints are not overwritten in your commit.
51-
* *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.
52-
2. Run `cargo update` to update the Cargo.lock file (even sub-dependencies).
53-
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.
54-
4. Adapt the code to the new versions, if needed.
55-
5. Create a PR with your changes, and link all dependabot PRs in the description.

content/docs/guides/contribute/license-and-set-up.fr.md

-16
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,3 @@ Grâce à `docker`, on peut facilement compiler, configurer, et lancer les diff
3838
[^docker-desktop]: Sous Windows/[WSL](https://learn.microsoft.com/fr-fr/windows/wsl/tutorials/wsl-containers), [Docker Desktop](https://www.docker.com/products/docker-desktop/) est recommandé
3939

4040
*[Continuer vers la contribution au code ‣]({{< ref "contribute-code">}})*
41-
42-
#### Spécifique `editoast` : mise à jour groupée des dépendances
43-
44-
Nous utilisons dependabot sur le projet pour signaler quand les dépendances sont obsolètes. Nous ne nous en servons pas pour mettre à jour automatiquement les dépendances, pour intégrer toutes les mises à jour en une seule fois et relire les modifications.
45-
46-
Pour mettre à jour les dépendances :
47-
48-
1. Changez les versions.
49-
* *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".
50-
Cela mettra à jour toutes les dépendances vers leur dernière version, et écrasera les contraintes de version trop larges.
51-
Assurez-vous que la nouvelle version choisie est stable, et que les contraintes volontairement larges ne sont pas écrasées par votre commit.
52-
* *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.
53-
2. Exécutez `cargo update` pour mettre à jour le fichier Cargo.lock (y compris les sous-dépendances).
54-
3. Vérifiez que toutes les [PRs dependabot editoast](https://github.com/osrd-project/osrd/pulls?q=is%3Aopen+label%3Aarea%3Aeditoast+label%3Adependencies) sont inclus dans votre commit.
55-
4. Adaptez le code aux nouvelles versions, si nécessaire.
56-
5. Créez une PR avec vos modifications, et reliez-y tous les PRs dependabot en description.

0 commit comments

Comments
 (0)