Skip to content

Commit 9826be3

Browse files
bougue-pemultun
authored andcommitted
editoast, doc: move batch dependency description closer to code
This section was in osrd-website. This should allow for all component to easily document it separately close to the code, without overwhelming general documentation.
1 parent d08a1f4 commit 9826be3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

editoast/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,20 @@ OpenApi when a change has been made to an endpoint, run the following command:
7676
```sh
7777
cargo run openapi > openapi.yaml
7878
```
79+
80+
## Batch dependency updates
81+
82+
We use dependabot on the project to notify when dependencies are outdated.
83+
We do not use dependabot to automatically update dependencies, as we want to merge all updates at
84+
once and review the changes (and avoid flooding `dev` branch with dependency-bump commits).
85+
86+
Here is the process to update dependencies:
87+
88+
1. Change the versions.
89+
* *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.
90+
Make sure that the new chosen version is stable, and that loose constraints are not overwritten in your commit.
91+
* *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.
92+
2. Run `cargo update` to update the Cargo.lock file (even sub-dependencies).
93+
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.
94+
4. Adapt the code to the new versions, if needed.
95+
5. Create a PR with your changes, and link all dependabot PRs in the description.

0 commit comments

Comments
 (0)