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

New CI #219

Merged
merged 8 commits into from
Jul 5, 2021
Merged

New CI #219

merged 8 commits into from
Jul 5, 2021

Conversation

marioortizmanero
Copy link
Collaborator

@marioortizmanero marioortizmanero commented Jul 2, 2021

This PR includes the new CI suggested in #213. It's merged over #215 to avoid merge conflicts later on.

@marioortizmanero marioortizmanero changed the base branch from master to auth-rewrite-part3 July 2, 2021 10:00
@marioortizmanero marioortizmanero marked this pull request as draft July 2, 2021 10:07
@marioortizmanero
Copy link
Collaborator Author

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.

@marioortizmanero
Copy link
Collaborator Author

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 master branch (they work with https://github.com/ramsayleung/rspotify/blob/auth-rewrite-part3/examples/auth_code.rs for now)

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.

@marioortizmanero marioortizmanero marked this pull request as ready for review July 2, 2021 11:49
@marioortizmanero marioortizmanero marked this pull request as draft July 2, 2021 12:08
@marioortizmanero marioortizmanero removed the request for review from ramsayleung July 2, 2021 12:08
@marioortizmanero marioortizmanero force-pushed the new-ci branch 2 times, most recently from b183b2e to 7347f9c Compare July 2, 2021 13:33
@marioortizmanero
Copy link
Collaborator Author

After a lot of debugging, turns out it's very complicated to have a clean run of cargo-deadlinks (i.e. without errors). For example, ours fails due to an external crate, tokio-rs/tracing#1078.

Thus, I'm adding a cargo-deadlinks flow, but it will continue on error for now. This is what Bevy does as well, so it makes sense to me. It's still useful to check from time to time and it avoids unfixable errors.

This is ready for review, @ramsayleung

@marioortizmanero marioortizmanero marked this pull request as ready for review July 3, 2021 10:16
run: cargo install cargo-deadlinks

- name: Build and Check
run: RUSTDOCFLAGS='-D warnings' cargo doc --features=cli,env-file
Copy link
Owner

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?

Copy link
Collaborator Author

@marioortizmanero marioortizmanero Jul 5, 2021

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.

@ramsayleung
Copy link
Owner

I have to say, the cargo-deadlinks is great, it helps us find the broken links, instead of identifying it manually.

@ramsayleung ramsayleung merged commit 84286e0 into auth-rewrite-part3 Jul 5, 2021
@ramsayleung ramsayleung deleted the new-ci branch July 5, 2021 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants