Skip to content

oss: clean up internal developer references for OSS readiness - #20

Merged
rominf merged 1 commit into
mainfrom
oss-cleanup-internal-references
Jun 23, 2026
Merged

oss: clean up internal developer references for OSS readiness#20
rominf merged 1 commit into
mainfrom
oss-cleanup-internal-references

Conversation

@rominf

@rominf rominf commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

Prepares the repository for public release by removing personal developer identifiers and placeholder paths.

Changes

  • Keyring service ID (apps/rocm/src/provider_keys.rs): replaced personal GitHub username with namespaced neutral identifier org.rocm.rocm-cli.provider-key
  • Package manifest (Cargo.toml): updated repository field to https://github.com/ROCm/rocm-cli
  • Install scripts (README.md, install.sh, install.ps1): updated download URLs to point to ROCm/rocm-cli
  • Project dirs (crates/rocm-core/src/runtime.rs): updated ProjectDirs qualifier/org to org/ROCm
  • Engine test fixtures (engines/atom, engines/sglang, engines/vllm, engines/lemonade): replaced developer home paths (/home/jam/.venv/, D:/jam/...) with generic examples
  • App test data (apps/rocm/src/main.rs, tui.rs, therock.rs): replaced developer-specific Windows/WSL paths with generic examples
  • Build scripts (scripts/): replaced hardcoded developer paths with portable equivalents; single_exe_release_gate.py now anchors the WSL --cd directory to REPO_ROOT (via the existing wsl_path() helper) instead of a hardcoded path
  • Docs and plans: replaced developer-specific paths in example commands

Breaking changes

  • Keyring service ID rename (powderluv.rocm-cli.provider-key → org.rocm.rocm-cli.provider-key): the OS keyring stores provider API keys under this service name, so any key saved by a pre-existing install will no longer be found after upgrading. Affected users must re-save their key with rocm config set-provider-key <provider> (or set the provider's API-key environment variable). No data is lost; the old entry simply becomes orphaned. Acceptable for a pre-OSS-release rename, but noted here for anyone running an earlier build.

Test Plan

  • cargo check --workspace passes
  • cargo test --workspace — 750/751 tests pass (1 pre-existing flaky test in TUI, confirmed on main)
  • cargo clippy --workspace -- -D warnings — zero warnings
  • cargo fmt --check --all — clean (formatting fix committed as part of this PR)
  • No powderluv, jam user references remain in any tracked file

@rominf

rominf commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator Author

Reviewed for OSS-readiness. Completeness and leak scans are clean (no powderluv/jam references remain, no internal-tracker/host leaks in the diff). All Rust test-fixture and help-string substitutions are internally consistent.

Applied two fixes (pushed to this branch):

  • e5a5907 fix: convert cwd to WSL path form for wsl --cd in release gate — the cleanup replaced the hardcoded --cd /mnt/d/jam/rocm-cli (a /mnt-style Linux path) with str(Path.cwd()). run_wsl_smoke runs on Windows hosts (--wsl defaults to os.name == 'nt'), where Path.cwd() is a Windows path (D:\...) that doesn't match the Linux-path form wsl --cd expects. Switched to the existing wsl_path() helper (the same conversion already used for the artifact one line above) to preserve the original semantics.
  • ba24afa docs: use ROCm brand casing in wsl.md venv example — D:\rocm\venv → D:\ROCm\venv for consistency with the D:\ROCm\... casing used everywhere else in this PR.

Also updated the PR description with a Breaking changes note: the keyring service rename (powderluv.rocm-cli.provider-key → rocm-cli.provider-key) orphans provider API keys saved by pre-existing installs; affected users must re-run rocm config set-provider-key.

@rominf
rominf marked this pull request as ready for review June 17, 2026 12:01
@rominf
rominf force-pushed the oss-cleanup-internal-references branch from ba24afa to 74d2d73 Compare June 17, 2026 12:12
@rominf
rominf requested a review from Copilot June 17, 2026 13:48
Copilot AI reviewed Jun 17, 2026
View reviewed changes

Copilot AI 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.

Pull request overview

Prepares rocm-cli for open-source release by removing internal developer identifiers (usernames and home directory paths) and updating public-facing links/identifiers to ROCm-owned, neutral values.

Changes:

  • Updated repository/download references (Cargo metadata, README, install scripts) to https://github.com/ROCm/rocm-cli.
  • Replaced developer-specific filesystem paths in scripts, docs, and test fixtures with generic examples.
  • Renamed keyring service ID and refreshed a few runtime/config path-related identifiers for OSS readiness.

Reviewed changes

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

Show a summary per file
File Description
scripts/single_exe_release_gate.py Removes hardcoded WSL user/path from smoke command invocation.
scripts/rust_cosmopolitan_spike.py Updates Windows guidance message to avoid referencing a specific WSL user.
scripts/build_single_exe_release.py Replaces developer-specific Windows llvm-strip.exe probe paths with generic placeholders.
README.md Updates bootstrap installer URLs to ROCm/rocm-cli.
plans/rocm-cli-remaining-implementation-plan.md Replaces developer home paths in example commands.
plans/cosmopolitan-runtime-boundary-plan.md Replaces developer-specific Windows/Linux example paths.
install.sh Defaults GitHub repo to ROCm/rocm-cli.
install.ps1 Defaults GitHub repo to ROCm/rocm-cli.
engines/vllm/src/lib.rs Replaces developer home paths in test fixtures.
engines/sglang/src/lib.rs Replaces developer home paths in test fixtures.
engines/lemonade/src/lib.rs Replaces developer-specific Windows paths in tests.
engines/atom/src/lib.rs Replaces developer home paths in test fixtures.
docs/wsl.md Replaces developer-specific venv path example.
docs/testing.md Replaces developer home paths in testing commands.
docs/sglang.md Replaces developer home path in acceptance harness example.
docs/implementation-completion-audit.md Replaces developer paths in WSL verification snippets.
docs/current-tui-therock-correction-plan.md Removes internal branch reference; replaces WSL command paths.
docs/cosmopolitan-universal-binary-plan.md Removes internal branch reference.
docs/atom.md Replaces developer home path in acceptance harness example.
crates/rocm-core/src/runtime.rs Updates ProjectDirs org/qualifier and refreshes path-related test fixtures.
Cargo.toml Updates repository field to https://github.com/ROCm/rocm-cli.
apps/rocm/src/tui.rs Replaces developer-specific Windows/WSL paths in help text and tests.
apps/rocm/src/therock.rs Replaces developer-specific Windows/WSL paths in tests.
apps/rocm/src/provider_keys.rs Renames keyring service ID to a neutral identifier.
apps/rocm/src/main.rs Replaces developer-specific install path examples in assistant text and tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread scripts/build_single_exe_release.py
Comment thread apps/rocm/src/provider_keys.rs Outdated
@rominf
rominf requested a review from Copilot June 17, 2026 14:17
Copilot AI reviewed Jun 17, 2026
View reviewed changes

Copilot AI 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.

Pull request overview

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

Comment thread scripts/single_exe_release_gate.py Outdated
Comment thread scripts/rust_cosmopolitan_spike.py Outdated
Comment thread apps/rocm/src/provider_keys.rs Outdated
juhovainio
juhovainio approved these changes Jun 18, 2026
View reviewed changes

@juhovainio juhovainio left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@rominf lgtm, but pls double check the co-pilot comments before merge

@rominf
rominf force-pushed the oss-cleanup-internal-references branch 4 times, most recently from 3b8c82a to 7ae3f53 Compare June 22, 2026 12:05
@rominf
oss: clean up internal developer references for OSS readiness
c9a6b7a 
Replace personal developer identifiers that would be inappropriate in a
public repository:

- Cargo.toml, README.md, install.sh, install.ps1: update repository and
  download URLs from powderluv/rocm-cli to ROCm/rocm-cli
- apps/rocm/src/provider_keys.rs: rename keyring service ID from
  powderluv.rocm-cli.provider-key to org.rocm.rocm-cli.provider-key
  (reverse-DNS convention; avoids collisions with other software)
- crates/rocm-core/src/runtime.rs: update ProjectDirs qualifier/org from
  com/powderluv to org/ROCm (relocates on-disk config dirs; intentional
  pre-release break)
- Engine test fixtures (atom, sglang, vllm, lemonade), app sources
  (main.rs, tui.rs, therock.rs), docs and plans: replace developer home
  paths (/home/jam/.venv/, D:\jam\...) with generic examples

Breaking: the keyring service rename and ProjectDirs qualifier change
orphan any provider API keys or config dirs from a pre-existing install.
Affected users must re-run `rocm config set-provider-key <provider>`.
@rominf
rominf force-pushed the oss-cleanup-internal-references branch from 7ae3f53 to c9a6b7a Compare June 22, 2026 14:56
@rominf
rominf added this pull request to the merge queue Jun 23, 2026
Merged via the queue into main with commit 964ba06 Jun 23, 2026
6 checks passed
@rominf
rominf deleted the oss-cleanup-internal-references branch June 23, 2026 07:11
@rominf rominf mentioned this pull request Jun 23, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@juhovainio juhovainio juhovainio approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rominf @juhovainio