-
Notifications
You must be signed in to change notification settings - Fork 123
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
New CI #219
New CI #219
Conversation
I've been taking a look at Bevy's CI and maybe we could copy some of their stuff? I'm taking a look right now. |
OK so I've added a flow that checks for broken links in the docs as well. This PR fixes all of them except for those that are impossible to fix until everything's merged. For example I added links to the new examples like https://github.com/ramsayleung/rspotify/blob/master/examples/auth_code.rs, but they won't work until the rewrite hits the As to having a flow for each crate I'm not sure if it's worth it. Specially because the macros crate doesn't have that many tests, for example. I think having a flow for each client might be enough for our case. |
b183b2e
to
7347f9c
Compare
After a lot of debugging, turns out it's very complicated to have a clean run of Thus, I'm adding a This is ready for review, @ramsayleung |
run: cargo install cargo-deadlinks | ||
|
||
- name: Build and Check | ||
run: RUSTDOCFLAGS='-D warnings' cargo doc --features=cli,env-file |
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.
Do we just check dead links for cli
and env-file
features, with ignoring other features?
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.
The rest of the features don't add anything new to the docs. Here I just generate the docs with everything possible in order to check for dead links.
I have to say, the |
This PR includes the new CI suggested in #213. It's merged over #215 to avoid merge conflicts later on.