bevyengine / bevyengine/bevy

`check-missing-*-in-docs` job does not install Rust

Open
#13,039 1 comment 0 reactions 0 assignees View on GitHub
A-Build-System C-Bug D-Trivial
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

In `ci.yml`, both `check-missing-examples-in-docs` and `check-missing-features-in-docs` do not install Rust before running it. This means that they are instead using the [implicitly installed Rust tools](https://github.com/actions/runner-images/blob/7861e423d5d645b70e34148c5c35f22ebf1c4e2c/images/ubuntu/Ubuntu2204-Readme.md#rust-tools) that come with the `ubuntu-latest` image.

This is an issue because the image versions of Rust may not update in lockstep with the rest of the Bevy project. Our current MSRV policy is "latest stable." If the image installation is behind, it may cause the jobs to spuriously fail.

To fix this, [`dtolnay/rust-toolchain@stable`](https://github.com/dtolnay/rust-toolchain) should used. See other jobs [such as `build`](https://github.com/bevyengine/bevy/blob/1df41b79dd5cec243046b2b5acce496ae3ec1dec/.github/workflows/ci.yml#L36) for reference.

https://github.com/bevyengine/bevy/blob/1df41b79dd5cec243046b2b5acce496ae3ec1dec/.github/workflows/ci.yml#L308-L317

https://github.com/bevyengine/bevy/blob/1df41b79dd5cec243046b2b5acce496ae3ec1dec/.github/workflows/ci.yml#L341-L349

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.