Skip to content

fix(integration): prevent stale script help guidance#3309

Draft
darion-yaphet wants to merge 1 commit into
github:mainfrom
darion-yaphet:fix/integration-script-help-py
Draft

fix(integration): prevent stale script help guidance#3309
darion-yaphet wants to merge 1 commit into
github:mainfrom
darion-yaphet:fix/integration-script-help-py

Conversation

@darion-yaphet

Copy link
Copy Markdown
Contributor

Updates the --script help text for specify integration install, switch, and upgrade so it lists all supported script types: sh, ps, and py.

The commands already accept py through the shared script-type resolver, but the help text only mentioned shell and PowerShell. This made valid Python-script usage look unsupported.

Testing

  • Verified specify integration install --help
  • Verified specify integration switch --help
  • Verified specify integration upgrade --help
  • Ran .venv/bin/python -m pytest tests/integrations/test_integration_subcommand.py -q

The integration lifecycle commands already accept the Python script type through the shared script-type resolver. Their option help still mentioned only shell and PowerShell, which made supported usage look invalid.

Constraint: Script type choices are defined centrally and currently include sh, ps, and py.

Confidence: high

Scope-risk: narrow

Tested: .venv/bin/specify integration install --help

Tested: .venv/bin/specify integration switch --help

Tested: .venv/bin/specify integration upgrade --help

Tested: .venv/bin/python -m pytest tests/integrations/test_integration_subcommand.py -q

Assisted-by: OpenAI Codex (model: GPT-5, autonomous)

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

Pull request overview

This PR updates the CLI help text for specify integration install, switch, and upgrade so the --script option accurately lists all supported script types, including Python (py), aligning the UX with the already-supported script-type resolver (SCRIPT_TYPE_CHOICES includes py).

Changes:

  • Updated --script help text in integration install to include py.
  • Updated --script help text in integration switch and integration upgrade to include py.
Show a summary per file
File Description
src/specify_cli/integrations/_install_commands.py Expands --script option help text to include py for specify integration install.
src/specify_cli/integrations/_migrate_commands.py Expands --script option help text to include py for specify integration switch and upgrade.

Review details

Tip

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

  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Low

@mnriem

mnriem commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Setting this to draft until all the sub issues mentioned in #3277 have been delivered

@mnriem mnriem marked this pull request as draft July 2, 2026 17:03
Sign up for free to 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.

3 participants