Skip to content

ci(miri): run doctests under Miri#23259

Merged
graphite-app[bot] merged 1 commit into
mainfrom
om/06-10-ci_miri_run_doctests_under_miri
Jun 11, 2026
Merged

ci(miri): run doctests under Miri#23259
graphite-app[bot] merged 1 commit into
mainfrom
om/06-10-ci_miri_run_doctests_under_miri

Conversation

@overlookmotel

@overlookmotel overlookmotel commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Running Miri on doctests was disabled in #11092. Unclear what oddity in the version of Rust nightly we were running at the time caused it not to work, but it now seems to be fixed, so we can re-enable the doctests now.

This is what caught the memory leaks in doc comment examples which were fixed in #23257.

@overlookmotel overlookmotel mentioned this pull request Jun 10, 2026
Merged
@overlookmotel Graphite App

overlookmotel commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent changes, fast-track this PR to the front of the merge queue

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions Bot added the A-allocator Area - Allocator label Jun 10, 2026
This was referenced Jun 10, 2026
Merged
Merged
@overlookmotel overlookmotel marked this pull request as ready for review June 10, 2026 20:56
Copilot AI review requested due to automatic review settings June 10, 2026 20:56
@codspeed-hq

codspeed-hq Bot commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 62 untouched benchmarks
⏩ 9 skipped benchmarks1

Comparing om/06-10-ci_miri_run_doctests_under_miri (32b4b51) with main (e69b321)2

Open in CodSpeed

Footnotes

  1. 9 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

  2. No successful run was found on om/06-10-ci_miri_run_miri_with_strict_provenance_enabled (437a564) during the generation of this report, so main (e69b321) was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

@overlookmotel overlookmotel self-assigned this Jun 10, 2026
@overlookmotel overlookmotel added the C-test Category - Testing. Code is missing test cases, or a PR is adding them label Jun 10, 2026
Copilot AI reviewed Jun 10, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Re-enables running Rust doctests under Miri in CI, and adjusts a long-running allocator documentation example so it won’t be executed as a doctest.

Changes:

  • Update Miri CI workflows to run cargo miri test without omitting doctests.
  • Mark a long-running Allocator documentation example as no_run to avoid executing it during doctests.
  • Minor workflow comment cleanup.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
crates/oxc_allocator/src/allocator.rs Marks the long-running doc example as no_run and adds a hidden explanatory comment.
.github/workflows/miri.yml Changes Miri invocation to include doctests (and now also default targets like examples).
.github/workflows/miri-windows.yml Same Miri target-selection change for the Windows Miri job.

Comment thread crates/oxc_allocator/src/allocator.rs Outdated
Comment thread .github/workflows/miri.yml Outdated
Comment thread .github/workflows/miri-windows.yml Outdated
@overlookmotel overlookmotel force-pushed the om/06-10-ci_miri_run_doctests_under_miri branch 3 times, most recently from 9e31299 to 32b4b51 Compare June 10, 2026 23:17
@overlookmotel overlookmotel force-pushed the om/06-10-ci_miri_run_miri_with_strict_provenance_enabled branch from 0e3af3e to 437a564 Compare June 10, 2026 23:17
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Jun 11, 2026
@overlookmotel Graphite App

overlookmotel commented Jun 11, 2026 •
edited by graphite-app Bot
Loading

Copy link
Copy Markdown
Member Author

Merge activity

@overlookmotel
ci(miri): run doctests under Miri (#23259)
79cd905 
Running Miri on doctests was disabled in #11092. Unclear what oddity in the version of Rust nightly we were running at the time caused it not to work, but it now seems to be fixed, so we can re-enable the doctests now.

This is what caught the memory leaks in doc comment examples which were fixed in #23257.
@graphite-app graphite-app Bot force-pushed the om/06-10-ci_miri_run_miri_with_strict_provenance_enabled branch from 437a564 to b77ca6f Compare June 11, 2026 00:17
@graphite-app graphite-app Bot force-pushed the om/06-10-ci_miri_run_doctests_under_miri branch from 32b4b51 to 79cd905 Compare June 11, 2026 00:18
@graphite-app graphite-app Bot removed the 0-merge Merge with Graphite Merge Queue label Jun 11, 2026
Base automatically changed from om/06-10-ci_miri_run_miri_with_strict_provenance_enabled to main June 11, 2026 00:23
@graphite-app graphite-app Bot merged commit 79cd905 into main Jun 11, 2026
33 checks passed
@graphite-app graphite-app Bot deleted the om/06-10-ci_miri_run_doctests_under_miri branch June 11, 2026 00:24
camc314 pushed a commit that referenced this pull request Jul 3, 2026
@overlookmotel @camc314
ci(miri): run doctests under Miri (#23259)
ea57511 
Running Miri on doctests was disabled in #11092. Unclear what oddity in the version of Rust nightly we were running at the time caused it not to work, but it now seems to be fixed, so we can re-enable the doctests now.

This is what caught the memory leaks in doc comment examples which were fixed in #23257.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

@overlookmotel overlookmotel

Labels

A-allocator Area - Allocator C-test Category - Testing. Code is missing test cases, or a PR is adding them

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@overlookmotel