Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

editoast, doc: move batch dependency description closer to code #6762

Merged
merged 1 commit into from
Feb 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions editoast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,20 @@ OpenApi when a change has been made to an endpoint, run the following command:
```sh
cargo run openapi > openapi.yaml
```

## Batch dependency updates

We use dependabot on the project to notify 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 (and avoid flooding `dev` branch with dependency-bump commits).

Here is the process to update dependencies:

1. Change the versions.
* *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 chosen version 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/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/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.
Loading