-
Notifications
You must be signed in to change notification settings - Fork 430
ci: Use just and adapt CONTRIBUTING.md and ci.yml accordingly #845
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
ci: Use just and adapt CONTRIBUTING.md and ci.yml accordingly #845
Conversation
ABorgna
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we should add a justfile so calling just test / just check / just miri adds the appropriate flags.
|
Ah, good point 🤔 I have to say that I am not the biggest fan of introducing non-cargo tooling, but since one can install it via cargo install, I'd be in favor as well :) I'll rename this PR then ^^ I suppose I'd also change the CI and everything as well then, to use them everywhere, right? |
|
Okay, should be adapted accordingly now :) Let me know if there's anything you think we should include / change 🦕 |
e6ddd55 to
d0b231b
Compare
starovoid
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything is good and beautiful except just build command.
|
Alright, thanks :) I felt like it could be nice to have one command which contributors can use which checks most of the things in one, so I added the Btw, I forgot to add your suggestion here in Github, so now it's in my commit instead, sry :o |
This PR fixes some clippy lints about lifetime annotations which occur when running clippy like it is run in CI using the nightly toolchain. More precisely, when running: ```bash cargo clippy --all-features --lib --bins --examples --tests -- -D warnings ``` or alternatively `just clippy` when #845 is merged, one gets multiple warnings (Errors because of `-D warnings`) of the following sort: ```bash error: lifetime flowing from input to output with different syntax can be confusing --> src/adj.rs:314:25 | 314 | pub fn edge_indices(&self) -> EdgeIndices<E, Ix> { | ^^^^^ ------------------ the lifetime gets resolved as '_ | | | this lifetime flows to the output | = note: -D mismatched-lifetime-syntaxes implied by -D warnings = help: to override -D warnings add #[allow(mismatched_lifetime_syntaxes)] help: one option is to remove the lifetime for references and use the anonymous lifetime for paths | 314 | pub fn edge_indices(&self) -> EdgeIndices<'_, E, Ix> { | +++ ``` This PR fixes these lints by exactly adding an anonymous lifetime to the return types and thus making the lifetime flow more explicit. Furthermore, a tiny change in the order of `std` and `no-std` generic parameters in `matrix_graph.rs` is made to make RustRover lints happy.
|
@starovoid do you accept the new version :) ? Because GitHub is still showing you as requesting changes and I don't want to just dismiss your request ^^ |
Everything looks great, I just haven't had a chance to look at it yet ^^ |
|
Ah, sry. I missunderstood then 😅 |
a35e630 to
6345278
Compare
6345278 to
e77aabc
Compare
…ph#845) This addresses the problem with CONTRIBUTING.md found in petgraph#844. Additionally, further details about CI actions which might be interesting to contributors were added such as miri, as well as running tests on different toolchains / rust versions. Resolves petgraph#844
This PR fixes some clippy lints about lifetime annotations which occur when running clippy like it is run in CI using the nightly toolchain. More precisely, when running: ```bash cargo clippy --all-features --lib --bins --examples --tests -- -D warnings ``` or alternatively `just clippy` when petgraph#845 is merged, one gets multiple warnings (Errors because of `-D warnings`) of the following sort: ```bash error: lifetime flowing from input to output with different syntax can be confusing --> src/adj.rs:314:25 | 314 | pub fn edge_indices(&self) -> EdgeIndices<E, Ix> { | ^^^^^ ------------------ the lifetime gets resolved as '_ | | | this lifetime flows to the output | = note: -D mismatched-lifetime-syntaxes implied by -D warnings = help: to override -D warnings add #[allow(mismatched_lifetime_syntaxes)] help: one option is to remove the lifetime for references and use the anonymous lifetime for paths | 314 | pub fn edge_indices(&self) -> EdgeIndices<'_, E, Ix> { | +++ ``` This PR fixes these lints by exactly adding an anonymous lifetime to the return types and thus making the lifetime flow more explicit. Furthermore, a tiny change in the order of `std` and `no-std` generic parameters in `matrix_graph.rs` is made to make RustRover lints happy.
…ph#845) This addresses the problem with CONTRIBUTING.md found in petgraph#844. Additionally, further details about CI actions which might be interesting to contributors were added such as miri, as well as running tests on different toolchains / rust versions. Resolves petgraph#844
This addresses the problem with CONTRIBUTING.md found in #844.
Additionally, further details about CI actions which might be interesting to contributors were added such as miri, as well as running tests on different toolchains / rust versions.
Resolves #844