Skip to content

Unpin Rust nightly in CI #6022

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

Merged
merged 1 commit into from
Jul 23, 2025
Merged

Conversation

ShaharNaveh
Copy link
Contributor

@ShaharNaveh ShaharNaveh commented Jul 23, 2025

Summary by CodeRabbit

  • Chores
    • Updated continuous integration workflow to use a generic nightly Rust toolchain for Miri tests.
    • Improved clarity and consistency in environment variable usage during test execution.

Copy link
Contributor

coderabbitai bot commented Jul 23, 2025

Walkthrough

The CI workflow for the "miri" job was updated to use a generic "nightly" Rust toolchain channel instead of a fixed nightly version. The environment variable for the toolchain was renamed, and the test execution step was modified to set Miri-specific flags using an explicit environment map.

Changes

File(s) Change Summary
.github/workflows/ci.yaml Updated "miri" job to use "nightly" channel via NIGHTLY_CHANNEL variable; refactored Miri test step to use explicit env map and updated cargo command.

Sequence Diagram(s)

sequenceDiagram
    participant CI_Workflow
    participant GitHub_Action
    participant Cargo
    participant Miri

    CI_Workflow->>GitHub_Action: Set NIGHTLY_CHANNEL="nightly"
    GitHub_Action->>Cargo: Use toolchain from NIGHTLY_CHANNEL
    CI_Workflow->>Cargo: Run tests with MIRIFLAGS='-Zmiri-ignore-leaks'
    Cargo->>Miri: Execute tests under Miri with specified flags
Loading

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

Poem

The workflow hops to nightly's tune,
No date to chase, just "nightly" soon!
Miri flags set with care and cheer,
Our CI runs are crystal clear.
🐇✨
Onward we bound, with less to fear!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
.github/workflows/ci.yaml (1)

356-365: Redundant “+${{ env.NIGHTLY_CHANNEL }}” — the toolchain override is already in effect.

dtolnay/rust-toolchain installs and overrides the directory with the requested toolchain (override: true by default).
Adding +nightly to the cargo invocation is therefore superfluous and slightly obscures intent.

A minimal adjustment:

-        run: cargo +${{ env.NIGHTLY_CHANNEL }} miri test -p rustpython-vm -- miri_test
+        run: cargo miri test -p rustpython-vm -- miri_test

This keeps the command shorter while still running under nightly.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ba22ad2 and 62adb7d.

📒 Files selected for processing (1)
  • .github/workflows/ci.yaml (1 hunks)
🧠 Learnings (2)
📓 Common learnings
Learnt from: arihant2math
PR: RustPython/RustPython#5790
File: build.rs:2-2
Timestamp: 2025-06-28T16:31:03.991Z
Learning: In Cargo build scripts (build.rs), the environment variable CARGO_CFG_TARGET_OS is guaranteed to exist and is automatically set by Cargo during the build process, making unwrap() safe to use when accessing this variable.
.github/workflows/ci.yaml (3)

Learnt from: ShaharNaveh
PR: #5932
File: .github/workflows/comment-commands.yml:18-24
Timestamp: 2025-07-10T10:08:43.330Z
Learning: In GitHub Actions workflows for the RustPython project, the maintainer ShaharNaveh prefers to keep workflows simple and doesn't mind if steps fail when the desired state is already achieved (e.g., user already assigned to an issue). Avoid suggesting complex error handling for edge cases they don't consider problematic.

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-19T03:16:56.511Z
Learning: Applies to Lib/test/**/*.py : When tests fail due to unsupported syntax, keep the test as @unittest.expectedFailure, document that it requires PEP 695 support, and focus on tests that can be fixed through Rust code changes only

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-19T03:16:56.511Z
Learning: Applies to **/*.rs : Always run clippy to lint code (cargo clippy) before completing tasks. Fix any warnings or lints that are introduced by your changes

🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: arihant2math
PR: RustPython/RustPython#5790
File: build.rs:2-2
Timestamp: 2025-06-28T16:31:03.991Z
Learning: In Cargo build scripts (build.rs), the environment variable CARGO_CFG_TARGET_OS is guaranteed to exist and is automatically set by Cargo during the build process, making unwrap() safe to use when accessing this variable.
.github/workflows/ci.yaml (3)

Learnt from: ShaharNaveh
PR: #5932
File: .github/workflows/comment-commands.yml:18-24
Timestamp: 2025-07-10T10:08:43.330Z
Learning: In GitHub Actions workflows for the RustPython project, the maintainer ShaharNaveh prefers to keep workflows simple and doesn't mind if steps fail when the desired state is already achieved (e.g., user already assigned to an issue). Avoid suggesting complex error handling for edge cases they don't consider problematic.

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-19T03:16:56.511Z
Learning: Applies to Lib/test/**/*.py : When tests fail due to unsupported syntax, keep the test as @unittest.expectedFailure, document that it requires PEP 695 support, and focus on tests that can be fixed through Rust code changes only

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-19T03:16:56.511Z
Learning: Applies to **/*.rs : Always run clippy to lint code (cargo clippy) before completing tasks. Fix any warnings or lints that are introduced by your changes

Comment on lines 351 to +352
env:
RUSTUP_TOOLCHAIN: nightly-2025-07-18 # TODO: Set to "nightly" once https://github.com/rust-lang/rust/issues/144168 is fixed
NIGHTLY_CHANNEL: nightly
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Prefer the built-in RUSTUP_TOOLCHAIN variable over a bespoke NIGHTLY_CHANNEL.

RUSTUP_TOOLCHAIN is understood by both cargo and rustup; setting it once eliminates the need to thread a custom variable through every command. Unless you have a strong reason to diverge, consider reverting to the canonical env-var.


🏁 Script executed:

#!/bin/bash
# Check for remaining references to the old variable that would now be dead code.
rg -n 'RUSTUP_TOOLCHAIN' .github/workflows

Length of output: 42


🏁 Script executed:

#!/bin/bash
# Verify all usages of the custom NIGHTLY_CHANNEL variable in CI workflows
rg -n 'NIGHTLY_CHANNEL' .github/workflows -A2

Length of output: 680


Replace custom NIGHTLY_CHANNEL with the built-in RUSTUP_TOOLCHAIN

To standardize on the canonical toolchain variable and avoid threading a bespoke env var through every command, update your CI workflow as follows:

• In .github/workflows/ci.yaml around line 352, rename the environment variable:

-    env:
-      NIGHTLY_CHANNEL: nightly
+    env:
+      RUSTUP_TOOLCHAIN: nightly

• In the Rust setup step (around line 358), point toolchain at the new var:

-        with:
-          toolchain: ${{ env.NIGHTLY_CHANNEL }}
+        with:
+          toolchain: ${{ env.RUSTUP_TOOLCHAIN }}

• In the Miri test step (around line 364), you can drop the +${…} prefix now that the default toolchain is set:

-        run: cargo +${{ env.NIGHTLY_CHANNEL }} miri test -p rustpython-vm -- miri_test
+        run: cargo miri test -p rustpython-vm -- miri_test

This ensures both rustup and cargo honor your chosen nightly channel without a custom variable.

🤖 Prompt for AI Agents
In .github/workflows/ci.yaml around lines 351 to 364, replace the custom
environment variable NIGHTLY_CHANNEL with the built-in RUSTUP_TOOLCHAIN to
standardize the toolchain usage. Rename the env variable NIGHTLY_CHANNEL to
RUSTUP_TOOLCHAIN at line 352, update the Rust setup step near line 358 to use
the new RUSTUP_TOOLCHAIN variable for the toolchain setting, and modify the Miri
test step around line 364 to remove the '+${…}' prefix since the default
toolchain is now set via RUSTUP_TOOLCHAIN. This change ensures rustup and cargo
consistently use the specified nightly channel without a bespoke env var.

@youknowone youknowone merged commit d897f9e into RustPython:main Jul 23, 2025
12 checks passed
@ShaharNaveh ShaharNaveh deleted the unpin-nightly branch July 23, 2025 08:58
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