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

Add rustdoc tests to CI #1210

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Conversation

dannycjones
Copy link
Contributor

There's a few rustdoc tests in the code base however CI did not previously ensure they passed or even compiled. This change fixes broken doctests and adds a new job to run these in CI.

This will allow us to write new doctests and be sure that they will be validated by CI. For example, we may wish to write doctests asserting safety justifications.

Does this change impact existing behavior?

CI change only.

Does this change need a changelog entry?

No, this changes CI only.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).

@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:20 — with GitHub Actions Inactive
@dannycjones dannycjones enabled auto-merge January 6, 2025 18:20
@dannycjones dannycjones marked this pull request as draft January 6, 2025 18:39
auto-merge was automatically disabled January 6, 2025 18:39

Pull request was converted to draft

@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:44 — with GitHub Actions Inactive
Signed-off-by: Daniel Carl Jones <[email protected]>
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests January 6, 2025 18:48 — with GitHub Actions Inactive
@dannycjones dannycjones marked this pull request as ready for review January 6, 2025 18:55
@dannycjones dannycjones enabled auto-merge January 6, 2025 18:55
Comment on lines +281 to +283
# setup-rust-toolchain sets "-D warnings" by default, and Rust treats any warning as compile error.
# We need to this currently because `vendor/fuser` contains some warnings and it breaks the build.
rustflags: ""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think warnings on vendor/fuser has been fixed recently, wonder if we can remove these overrides now.

@dannycjones dannycjones added this pull request to the merge queue Jan 7, 2025
Merged via the queue into awslabs:main with commit 89873a9 Jan 7, 2025
24 checks passed
@dannycjones dannycjones deleted the add-doctests-to-ci branch January 7, 2025 11:26
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