Skip to content

Improve help for app config link flags - #8787

Merged
gonzaloriestra merged 2 commits into
mainfrom
gonzalo/config-link-flag-error
Oct 6, 2026
Merged

gonzaloriestra merged 2 commits into
mainfrom
gonzalo/config-link-flag-error

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

The shared --config description doesn't explain how app config link uses the local configuration. When combined with --client-id, the generic flag conflict error also doesn't explain how to choose the destination file.

WHAT is this pull request doing?

Clarify the command's --config, --client-id, and --file-name descriptions. Show a custom error recommending --file-name when both --config and --client-id are provided, before attempting to link the app. Cover command-line flags and environment variables, and refresh the generated command manifest, README, and docs.

How to manually test your changes?

pnpm shopify app config link --help
pnpm shopify app config link --config staging --client-id example-client-id

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset

@github-actions github-actions Bot added the Area: @shopify/app @shopify/app package issues label Oct 6, 2026
@gonzaloriestra gonzaloriestra changed the title Recommend --file-name for conflicting app config link flags Clarify app config link flags and recommend --file-name on conflicts Oct 6, 2026
@gonzaloriestra gonzaloriestra changed the title Clarify app config link flags and recommend --file-name on conflicts Improve help for app config link flags Oct 6, 2026
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review October 6, 2026 09:26
@gonzaloriestra
gonzaloriestra requested review from a team as code owners October 6, 2026 09:26
@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Oct 6, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 6, 2026
@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Oct 6, 2026
Merged via the queue into main with commit 767e8c2 Oct 6, 2026
32 checks passed
@gonzaloriestra
gonzaloriestra deleted the gonzalo/config-link-flag-error branch October 6, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/app @shopify/app package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants