Skip to content

docs: add Swift package profiling guidance#48

Merged
gaelic-ghost merged 2 commits intomainfrom
docs/swift-package-instrumentation-testing
May 7, 2026
Merged

docs: add Swift package profiling guidance#48
gaelic-ghost merged 2 commits intomainfrom
docs/swift-package-instrumentation-testing

Conversation

@gaelic-ghost
Copy link
Copy Markdown
Owner

@gaelic-ghost gaelic-ghost commented May 7, 2026

Summary

  • add Apple silicon-focused Swift Package profiling guidance for OSSignposter, xctrace, Time Profiler, Metal System Trace, Allocations, VM Tracker, Audio, MLX, local AI, and trace artifact reporting
  • add Xcode Testing workflow guidance for Instruments trace capture and interpretation handoffs
  • bump shared Socket version surfaces to 6.7.15

Subtree accounting

Verification

  • uv run scripts/validate_socket_metadata.py
  • bash .github/scripts/validate_repo_docs.sh
  • uv run pytest

Summary by CodeRabbit

  • New Features

    • Added comprehensive performance-sensitive testing and profiling guides for Swift packages and Xcode workflows.
    • Expanded Instruments profiling documentation with detailed command guidance and profiling checklist.
  • Documentation

    • New reference documents for performance profiling workflows on Apple platforms.
    • Updated testing workflow documentation with performance profiling integration and tool guidance.
    • Extended CLI command guidance for profiling tools and trace capture.
  • Chores

    • Version bumped to 6.7.15.

@gaelic-ghost gaelic-ghost added the documentation Improvements or additions to documentation label May 7, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR increments the project and all plugin versions from 6.7.14 to 6.7.15, and expands the Apple dev skills plugin with comprehensive Instruments/performance profiling guidance spanning Swift package and Xcode testing workflows, including new reference documents, CLI command matrices, and updated workflow routing.

Changes

Version Bump Across Project and Plugins

Layer / File(s) Summary
Root Project Version
pyproject.toml
Root [project] version field updated to 6.7.15.
Plugin Manifests
plugins/*/.codex-plugin/plugin.json
All 11 plugin manifest version fields incremented to 6.7.15.
Plugin Project Metadata
plugins/*/pyproject.toml, plugins/*/mcp/pyproject.toml
Eight plugin [project].version fields updated to 6.7.15.

Apple Dev Skills Performance Profiling Expansion

Layer / File(s) Summary
Roadmap Planning
plugins/apple-dev-skills/ROADMAP.md
Milestone 29 extended with ticket covering performance-sensitive workflows, profiling tools, and trace artifact reporting.
Swift Package Testing Workflow
plugins/apple-dev-skills/skills/swift-package-testing-workflow/SKILL.md
SKILL.md updated: "When To Use" adds performance-sensitive testing bullet; workflow steps route profiling requests to dedicated reference; handoffs add Instruments/xctrace conditions; references list includes new profiling doc.
Swift Package Profiling References
plugins/apple-dev-skills/skills/swift-package-testing-workflow/references/performance-sensitive-testing-and-profiling.md, cli-command-matrix.md, package-resources-testing-and-builds.md
New performance-sensitive-testing-and-profiling.md created with workload design, OSSignposter conventions, Instruments selection rules, xctrace commands, and handoff guidance. CLI matrix extended with xctrace toolchain checks and profiling section. Package resources guidance clarifies performance-sensitive workload handling.
Xcode Testing Workflow
plugins/apple-dev-skills/skills/xcode-testing-workflow/SKILL.md
SKILL.md updated: "When To Use" adds Instruments profiling bullet; references list includes instruments profiling doc; fallback guidance expanded for SwiftPM-first profiling scenarios.
Xcode Profiling References
plugins/apple-dev-skills/skills/xcode-testing-workflow/references/instruments-performance-profiling.md, cli-fallback-matrix.md, testing-plans-file-membership-and-configurations.md
New instruments-performance-profiling.md created with Apple Silicon baseline, instrument selection, trace capture flow, xctrace command examples, and workflow handoffs. CLI fallback matrix extended with xctrace tools and record examples. Testing plans documentation adds Instruments profiling section with cross-reference and architecture baseline guidance.

🎯 2 (Simple) | ⏱️ ~12 minutes

🐰 A version bump hops with glee,
From 6.7.14 to 6.7.15!
With Instruments profiling so bright,
Swift and Xcode workflows unite,
Performance tracing now complete! 🎯

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the primary change: adding Swift package profiling guidance documentation across multiple skills.
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
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/swift-package-instrumentation-testing

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

@gaelic-ghost gaelic-ghost merged commit 19e00cf into main May 7, 2026
1 of 2 checks passed
@gaelic-ghost gaelic-ghost deleted the docs/swift-package-instrumentation-testing branch May 7, 2026 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant