Skip to content

🤖 feat: complete the Mux to Xum rename - #3928

Open
matifali wants to merge 16 commits into
mainfrom
rename-all-mux-mnentions-to-xum-the-project-was
Open

🤖 feat: complete the Mux to Xum rename#3928
matifali wants to merge 16 commits into
mainfrom
rename-all-mux-mnentions-to-xum-the-project-was

Conversation

@matifali

Copy link
Copy Markdown
Member

Summary

Complete the remaining Mux → Xum rename across the desktop app, internal TypeScript API, persisted storage, branding assets, VS Code integration, documentation, developer tooling, and Terminal-Bench harness.

What changed

  • Make ~/.xum and Electron userData/xum canonical while retaining centralized .mux / .cmux migration, read fallback, and downgrade aliases.
  • Harden migration rollback so data returns to the actual legacy source if compatibility alias creation fails, and align pre-startup home discovery with migration behavior.
  • Rename project-owned Mux* message, provider, ACP, Gateway/Governor, SSH, and mDNS symbols to Xum* while preserving serialized and wire-level compatibility values.
  • Replace the Mux-derived icon geometry with a distinct four-ribbon Xum mark and regenerate desktop, tray, favicon, PWA, docs, and VS Code assets.
  • Make xum canonical in Make targets, logs, service-worker caches, workflows, benchmarks, docs, fixtures, and visible UI; retain explicit compatibility aliases where existing consumers depend on them.
  • Add make check-xum-branding, backed by a reviewed compatibility allowlist, plus non-writing icon freshness/dimension/content validation.

Compatibility contracts retained

  • com.mux.app installer identity and mux:// deep links.
  • mux CLI/npm forwarding package and mux-* release artifacts.
  • .mux, .cmux, .muxignore, and MUX_* fallback/alias behavior.
  • VS Code Marketplace/package IDs and persisted mux.* command/settings keys.
  • Serialized/wire/provider/discovery values including muxMetadata, X-Mux-Workspace-Id, mux-gateway, and _mux-api._tcp.
  • External endpoints that still use established Mux identities, such as mux.coder.com and ghcr.io/coder/mux.

Validation

  • make check-xum-branding
  • bun scripts/generate-icons.ts check
  • make fmt-check
  • make lint
  • make typecheck
  • Focused compatibility/path/product/protocol/log suites: 93 passed, 5 skipped
  • Xum transition suite: 28 passed, 5 skipped
  • Terminal-Bench adapter suite: 24 passed
  • Trust CLI suite: 5 passed

The full source suite was also exercised: 11,843 passed, 14 skipped, with unrelated environment/global-isolation failures in existing backup/Git, timing, browser, and filesystem tests.


Generated with xum • Model: openai:gpt-5.6-sol • Thinking: high

Replace the reused x-and-cursor icon with a compact four-part convergence
mark, regenerate every tracked square branding asset, and add a non-writing
freshness and image-validity check to the canonical generator.
Validation:
- bun scripts/generate-icons.ts update
- bun scripts/generate-icons.ts check
- make build-icons
- make typecheck
- make fmt-check
- make lint
Make Xum canonical for the Make CLI, Terminal-Bench harness, service-worker cache, local logs, and shared developer environment while preserving explicit legacy aliases and environment inputs.
Add a scoped, Make-backed branding audit with behavioral coverage for stale copy and filenames.
@mintlify

mintlifyBot commented Aug 22, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

ProjectStatusPreviewUpdated (UTC)
Mux🟢 ReadyView PreviewAug 22, 2026, 8:56 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review

@chatgpt-codex-connector

This comment has been minimized.

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:c5043ef444

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread.github/workflows/terminal-bench.yml
Comment threadbenchmarks/terminal_bench/prepare_leaderboard_submission.py Outdated
Comment threadbenchmarks/terminal_bench/xum_agent.py Outdated
@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review
Please take another look at the latest commit.

@matifali

Copy link
Copy Markdown
MemberAuthor

Addressed all Codex findings in c93dcda:

  • Updated both BigQuery uploaders to prefer XUM_EXPERIMENTS / XUM_RUN_AS_GOAL by key presence with MUX_* fallback.
  • Excluded both canonical and pre-rename app/token artifacts from leaderboard submissions.
  • Made empty canonical benchmark env values explicitly clear legacy aliases and added regression coverage.

Validation: make fmt-check, make lint-actions, make check-bench-agent, uploader precedence checks, and Python compilation.

@codex review

@matifali

Copy link
Copy Markdown
MemberAuthor

Follow-up: the required legacy leaderboard artifact exclusions are now covered by a narrow, documented branding-audit allow rule with regression coverage. make static-check-full passes locally.

@codex review

@chatgpt-codex-connector

This comment has been minimized.

@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review
Please retry the review; the previous attempt returned an unknown error.

@chatgpt-codex-connector

This comment has been minimized.

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:74edb2682d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadsrc/common/types/message.ts
@matifali

Copy link
Copy Markdown
MemberAuthor

Addressed the public package compatibility finding in e199f37 by retaining MuxMessage as a documented alias of canonical XumMessage.

Validated with root typecheck/message suites and the separately published @coder/mux-chat-components package typecheck + production build.

@codex review

@chatgpt-codex-connector

This comment has been minimized.

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:e199f37f99

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadbenchmarks/terminal_bench/xum_agent.py Outdated
@matifali

Copy link
Copy Markdown
MemberAuthor

Addressed the providers-file precedence finding: compatibility env lookups now share one presence-based resolver, so an explicitly empty XUM_PROVIDERS_FILE suppresses a stale MUX_PROVIDERS_FILE. Added regression coverage and validated the branch behavior plus benchmark agent checks.

@codex review

@chatgpt-codex-connector

This comment has been minimized.

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:8cac1f7504

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadbenchmarks/terminal_bench/xum_agent.py Outdated
@matifali

Copy link
Copy Markdown
MemberAuthor

Addressed the repo-root precedence finding: XUM_AGENT_REPO_ROOT now uses the same presence-based compatibility resolver, so an explicit empty canonical value suppresses a stale legacy root and falls back to the checked-in adapter root. Added Harbor-backed regression coverage.

@codex review

@chatgpt-codex-connector

This comment has been minimized.

@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review
Please retry the review; the previous attempt returned an unknown error. All prior findings are resolved and the latest commit is dfc29c0b0.

@chatgpt-codex-connector

This comment has been minimized.

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:dfc29c0b05

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadvscode/media/xumChatView.js
Comment threadsrc/node/services/log.ts Outdated
@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review
Please review the latest commit dfc29c0b0; all previous findings are fixed and resolved.

@matifali

Copy link
Copy Markdown
MemberAuthor

Addressed the latest Codex findings:

  • Updated the enabled VS Code chat placeholder to “Message Xum…”.
  • clearLogFiles() now removes pre-rename mux.log and mux.N.log files alongside canonical rotations, with regression coverage.

Validation: log tests (7 passed), VS Code extension build, root typecheck, formatting, and branding audit.

@codex review

@matifali

Copy link
Copy Markdown
MemberAuthor

Follow-up: the intentional pre-rename log cleanup is now covered by a narrow branding-audit compatibility rule with regression coverage. Local branding/format checks pass.

@codex review

@matifali

Copy link
Copy Markdown
MemberAuthor

Final follow-up: adjusted the legacy log cleanup regression test to use async filesystem APIs. Log tests, lint, and make static-check-full pass locally.

@codex review

@chatgpt-codex-connector

This comment has been minimized.

@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review
Please provide the final code review for commit 5677ce54e; all review threads are resolved and local validation is green.

@chatgpt-codex-connector

This comment has been minimized.

@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review
All findings are addressed and all required CI checks pass. Please provide the final code-review decision for commit 5677ce54e.

@chatgpt-codex-connector

This comment has been minimized.

@matifali

Copy link
Copy Markdown
MemberAuthor

@codex review

@chatgpt-codex-connector

This comment has been minimized.

Sign up for freeto 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.

1 participant

@matifali