feat(CI): add external type check #2957
Conversation
…i-check-external-types
Cargo.toml
Outdated
| @@ -45,6 +45,7 @@ libc = { version = "0.2", optional = true } | |||
| socket2 = { version = "0.4", optional = true } | |||
|
|
|||
| [dev-dependencies] | |||
| cargo-check-external-types = "0.1.2" | |||
There was a problem hiding this comment.
Would it be possible to make the dependency only installed in the CI workflow? So that most local dev doesn't need to download the extra dep?
ethanburrell
force-pushed
the
add-ci-check-external-types
branch
from
3fb768d to
0cc10bf
Compare
|
@seanmonstar Changed pipeline to install the dependency within the pipeline. |
|
Looks like the new job failed, can't find:
|
| uses: actions/checkout@v1 | ||
|
|
||
| - name: Install Rust | ||
| uses: actions-rs/toolchain@v1 |
There was a problem hiding this comment.
This action is unmaintained. It seems like people are coalescing around dtolnay/rust-toolchain as an alternative solution.
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v1 |
There was a problem hiding this comment.
We should use the latest version of this action. Older versions of this action depend on node versions that are deprecated in Github's runners.
| uses: actions/checkout@v1 | |
| uses: actions/checkout@v3 |
| uses: actions-rs/toolchain@v1 | ||
| with: | ||
| profile: minimal | ||
| toolchain: nightly |
There was a problem hiding this comment.
We should pin to a specific combination of nightly version/cargo-check-external-types that's known to work. The newest nightly version might introduce a new version of rustdoc JSON output that's incompatible with the version expected by cargo-check-external-type.
It'd be nicer if we could install the toolchain version listed in their toolchain file, but that's probably not necessary to get this PR in.
| override: true | ||
|
|
||
| - name: Install cargo-check-external-types | ||
| uses: actions-rs/install@v1 |
There was a problem hiding this comment.
Same issue as actions-rs/toolchain- I'd consider dtolnay/install instead.
| use-tool-cache: true | ||
|
|
||
| - name: check-external-types | ||
| uses: actions-rs/cargo@v1 |
There was a problem hiding this comment.
Same issue as the other actions-rs/* actions- I think here we can just invoke cargo manually.
Adding audit for issue #2925.
Uses the nightly build to uses rustdoc to create a diff with the exported types.