8000 Doc tests failing in CI · Issue #1276 · ggez/ggez · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Doc tests failing in CI #1276

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 commun 8000 ity.

Sign up for GitHub

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

Jump to bottom
Open
sampullman opened this issue Mar 12, 2024 · 3 comments
Open

Doc tests failing in CI #1276

sampullman opened this issue Mar 12, 2024 · 3 comments

Comments

@sampullman
Copy link

Doc tests are failing in CI on the rustc beta channel: example

To Reproduce
Submit any PR that triggers the CI workflow in Github actions.

Expected behavior
Doc tests pass

Notes

This is probably caused by skeptic, which appears to be unmaintained. In order to get doc tests working, it's probably necessary to either:

  1. Fix in skeptic and hope the maintainer is available to publish a release
  2. Switch to [builtin documentation tests. I'm not sure what special features of skeptic are used, or how much work the transition would take.
@a1phyr
Copy link
Member
a1phyr commented Mar 18, 2024

Native doc tests would not really work here as skeptic is used to test the README and the doc quide.

@sampullman
Copy link
Author

Temporary fix in #1274, keeping this open until a long term solution is found.

@sampullman
Copy link
Author

It's not as clean as skeptic, but as of 1.54 it should be possible to manually include all the doctests using #[doc = include_str!("../../README.md")] (seen here).

Some more work would need to be done to ensure test compatibility and rewrite or remove doc_tests/build.rs. A solution would also have to be found for skeptic template usage.
57FA

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sampullman @a1phyr
0