Skip to content

🔧 Maintenance round#1042

Merged
denialhaag merged 4 commits into
mainfrom
maintenance-round
Jun 17, 2026
Merged

🔧 Maintenance round#1042
denialhaag merged 4 commits into
mainfrom
maintenance-round

Conversation

@denialhaag

@denialhaag denialhaag commented Jun 17, 2026

Copy link
Copy Markdown
Member

Description

This PR makes several maintenance updates:

  • Fix required-checks-pass job
  • Use client-id instead of app-id
  • Update to new MQSC branding
  • Improve support for CLAUDE.md
  • Configure Read the Docs to use Python 3.14 for colorful docs
  • Make use of the fact that version 4.0.0 of cbuildwheel installs delvewheel by default

Checklist

  • The pull request only contains commits that are focused and relevant to this change.
  • I have added appropriate tests that cover the new/changed functionality.
  • I have updated the documentation to reflect these changes.
  • I have added entries to the changelog for any noteworthy additions, changes, fixes, or removals.
  • I have added migration instructions to the upgrade guide (if needed).
  • The changes follow the project's style guidelines and introduce no new warnings.
  • The changes are fully tested and pass the CI checks.
  • I have reviewed my own code changes.

@denialhaag denialhaag self-assigned this Jun 17, 2026
@denialhaag denialhaag added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Jun 17, 2026
@github-project-automation github-project-automation Bot moved this to In Progress in MQT Compilation Jun 17, 2026
@denialhaag

Copy link
Copy Markdown
Member Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Full review finished.

Comment thread .readthedocs.yaml
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 599827ae-a8d0-4924-92a3-7841d6fcd969

📥 Commits

Reviewing files that changed from the base of the PR and between 9941a01 and 9e956a8.

📒 Files selected for processing (2)
  • .github/workflows/cd.yml
  • .github/workflows/ci.yml

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Updated contributor/supporter links to use the shorter MQSC label and new https://mq.sc URL.
    • Updated Sphinx metadata (author/copyright) and set Read the Docs builds to Python 3.14.
  • CI / Build

    • Adjusted CI skip logic for selected test and coverage/lint jobs.
    • Updated GitHub App token creation input name in automation.
    • Refined Windows wheel build behavior by removing an extra pre-build step.
  • Chores

    • Updated .gitignore to exclude Claude-related files.

Walkthrough

This PR reworks the required-checks-pass CI job's allowed-skips expressions to use explicit negated conditions, renames a GitHub App token input field in the templating workflow, updates MQSC attribution links and Sphinx metadata across docs, bumps the ReadTheDocs Python version to 3.14, removes the Windows delvewheel pre-install step from cibuildwheel, and adds Claude-related entries to .gitignore.

Changes

CI and Workflow Changes

Layer / File(s) Summary
allowed-skips logic rework
​.github/workflows/ci.yml
All seven allowed-skips entries in the required-checks-pass job are rewritten using negated !fromJSON(...) conditions, controlling skippability for standard/extensive C++ jobs, coverage, linter, Python tests, extensive Python tests, and CD jobs.
GitHub App token field rename
​.github/workflows/templating.yml
The create-github-app-token step input key is renamed from app-id to client-id.
Workflow comment update
​.github/workflows/cd.yml
A single comment line is condensed to describe wheel artifact naming convention.

Docs, Branding, and Repo Config

Layer / File(s) Summary
MQSC attribution and Sphinx metadata
README.md, docs/index.md, docs/conf.py
MQSC supporter links updated to use the https://mq.sc URL with shortened "MQSC" label; docs/conf.py author and copyright fields extended to include Munich Quantum Software Company GmbH.
ReadTheDocs, cibuildwheel, and .gitignore
​.readthedocs.yaml, pyproject.toml, ​.gitignore
ReadTheDocs Sphinx build Python version bumped from 3.12 to 3.14; the before-build step installing delvewheel removed from the Windows cibuildwheel config; CLAUDE.md and ​.claude/ added to ​.gitignore.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

continuous integration

Suggested reviewers

  • burgholzer

Poem

🐇 A hop through the CI lane,
Skip logic flipped, negations reign!
MQSC now lives at mq.sc,
Python bumped to 3.14 with glee.
Claude's files tucked away from view —
A tidy warren, fresh and new! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title '🔧 Maintenance round' is vague and generic, using non-descriptive language that doesn't convey meaningful information about specific changes. Replace with a more specific title summarizing the main changes, such as 'Update GitHub Actions, MQSC branding, and CI configuration' or 'Maintenance: client-id migration and Python 3.14 upgrade'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The PR description includes a bulleted summary of changes and completed the checklist, though several items were marked as not applicable.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch maintenance-round

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/ci.yml:
- Around line 269-271: The allowed-skips condition for standard C++ tests uses
AND logic between the skip conditions, but the job's skip condition itself uses
OR logic. Change the AND operator (&&) to OR operator (||) in the allowed-skips
condition at line 269 so that the cpp-tests jobs are added to allowed-skips when
either !run-cpp-tests is true OR the extensive-cpp-ci label is present. This
will ensure the alls-green check properly handles all skip scenarios for the
cpp-tests-ubuntu, cpp-tests-macos, and cpp-tests-windows jobs.
- Around line 289-291: The allowed-skips condition for python-tests-extensive
uses AND operators when it should use OR operators. The job skips when
run-python-tests is false OR event_name is not a pull_request OR the
extensive-python-ci label is missing. Update the condition in the allowed-skips
section to use OR logic instead of AND logic so that the python-tests-extensive
job is correctly marked as allowed to skip when any of these skip conditions are
met (not when all of them are met simultaneously). This will prevent alls-green
from failing when the job legitimately skips due to being a push to main rather
than a pull request.
- Around line 273-275: The allowed-skips condition on lines 273-275 uses AND
logic (&&) to combine three skip conditions, but this is incorrect—it should use
OR logic (||) to match the actual skip condition from line 86. Currently, when
there is a push event with C++ changes where run-cpp-tests evaluates to true,
the !fromJSON(needs.change-detection.outputs.run-cpp-tests) condition becomes
false, causing the entire AND expression to evaluate to false and preventing the
extensive tests from being recognized as allowed-skips, which then causes the
alls-green check to fail. Change the && operators connecting
!fromJSON(needs.change-detection.outputs.run-cpp-tests),
!contains(github.event.pull_request.labels.*.name, 'extensive-cpp-ci'), and
github.event_name != 'pull_request' to || operators so that if ANY ONE of these
skip conditions is true, the extensive jobs are properly allowed to be skipped.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0f263fde-3d78-4295-afbd-d2ddf335f06c

📥 Commits

Reviewing files that changed from the base of the PR and between 4ab95fa and 9941a01.

📒 Files selected for processing (8)
  • .github/workflows/ci.yml
  • .github/workflows/templating.yml
  • .gitignore
  • .readthedocs.yaml
  • README.md
  • docs/conf.py
  • docs/index.md
  • pyproject.toml
💤 Files with no reviewable changes (1)
  • pyproject.toml

Comment thread .github/workflows/ci.yml Outdated
Comment thread .github/workflows/ci.yml Outdated
Comment thread .github/workflows/ci.yml Outdated
@denialhaag

Copy link
Copy Markdown
Member Author

@coderabbitai review

@denialhaag denialhaag requested a review from burgholzer June 17, 2026 16:14
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@codecov

codecov Bot commented Jun 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@burgholzer burgholzer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 👍🏼

Comment thread .readthedocs.yaml
Comment thread pyproject.toml
@denialhaag denialhaag merged commit f12faeb into main Jun 17, 2026
37 checks passed
@denialhaag denialhaag deleted the maintenance-round branch June 17, 2026 17:09
@github-project-automation github-project-automation Bot moved this from In Progress to Done in MQT Compilation Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants