Skip to content

Document Go CLI migration state and usage - #95

Merged
mrjf merged 3 commits into
mainfrom
copilot/document-go-cli-migration-state
Jun 1, 2026
Merged

Document Go CLI migration state and usage#95
mrjf merged 3 commits into
mainfrom
copilot/document-go-cli-migration-state

Conversation

CopilotAI commented May 28, 2026

Copy link
Copy Markdown
Contributor

Description

Documents the merged Python-to-Go CLI migration state so maintainers can understand what is verified, what remains Python-backed, and how to try the Go CLI without reading issue/PR history.

  • Migration state

  • Contributor usage

    • Adds copy-paste build/run commands:
      go build -o ./dist/apm-go ./cmd/apm
      ./dist/apm-go --help
      ./dist/apm-go init --yes
    • Adds local parity workflow with APM_PYTHON_BIN.
    • Adds manual Actions dispatch command.
  • Benchmark evidence

    • Points reviewers to the Migration Benchmarks summary and migration-benchmark-evidence artifact.
    • Explains the Go/Python ratio column and current smoke benchmark range.
  • Regression coverage

    • Adds README assertions to keep the migration status, usage commands, parity gate, and benchmark guidance documented.

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Maintenance / refactor

Testing

  • Tested locally
  • All existing tests pass
  • Added tests for new functionality (if applicable)

CopilotAI linked an issue May 28, 2026 that may be closed by this pull request
Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com>
CopilotAI changed the title [WIP] Add documentation for Go CLI migration state and usageDocument Go CLI migration state and usageMay 28, 2026
CopilotAI requested a review from mrjfMay 28, 2026 05:57
@mrjf

mrjf commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

@copilot fix ci

Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com>

CopilotAI commented Jun 1, 2026

Copy link
Copy Markdown
ContributorAuthor

@copilot fix ci

Fixed in 4fc3c48 by applying the missing ruff format change to tests/unit/test_readme_go_cli_migration.py. Locally verified ruff format --check src/ tests/, ruff check src/ tests/, and the targeted README migration test.

@mrjf
mrjf marked this pull request as ready for review June 1, 2026 21:30
@mrjf
mrjf merged commit a79756c into mainJun 1, 2026
6 checks passed
@mrjf
mrjf deleted the copilot/document-go-cli-migration-state branch June 1, 2026 21:30
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.

Document Go CLI migration state and usage

2 participants

@mrjf