Skip to content

Put organization commands into general commands#7165

Merged
isaacroldan merged 1 commit intomainfrom
04-02-put_organization_commands_into_general_commands
Apr 2, 2026
Merged

Put organization commands into general commands#7165
isaacroldan merged 1 commit intomainfrom
04-02-put_organization_commands_into_general_commands

Conversation

@isaacroldan
Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Fixes #0000

WHAT is this pull request doing?

How to test your changes?

Post-release steps

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
  • Existing analytics will cater for this addition
  • PR includes analytics changes to measure impact

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

Copy link
Copy Markdown
Contributor Author

isaacroldan commented Apr 2, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@isaacroldan isaacroldan marked this pull request as ready for review April 2, 2026 15:47
@isaacroldan isaacroldan requested review from a team as code owners April 2, 2026 15:47
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

@isaacroldan isaacroldan changed the base branch from fix-cli-lint-worktree to graphite-base/7165 April 2, 2026 15:47
@isaacroldan isaacroldan force-pushed the 04-02-put_organization_commands_into_general_commands branch from 69beb9d to 015aae8 Compare April 2, 2026 15:47
@isaacroldan isaacroldan changed the base branch from graphite-base/7165 to main April 2, 2026 15:47
Copilot AI review requested due to automatic review settings April 2, 2026 15:51
@isaacroldan isaacroldan force-pushed the 04-02-put_organization_commands_into_general_commands branch from 015aae8 to 15545ea Compare April 2, 2026 15:51
@isaacroldan isaacroldan merged commit f595cc4 into main Apr 2, 2026
7 checks passed
@isaacroldan isaacroldan deleted the 04-02-put_organization_commands_into_general_commands branch April 2, 2026 15:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Moves Shopify CLI “organization” commands out of their own documentation category and into the “general commands” bucket so they’re grouped with other cross-cutting CLI commands.

Changes:

  • Treat the organization topic as part of generalTopics during docs generation.
  • Regenerate docs artifacts so organization list is categorized under “general commands”.
  • Remove the standalone “organization” category page/template from the docs site.

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/cli/src/cli/commands/docs/generate.ts Adds organization to the topics that should be categorized as “general commands” during doc generation.
docs-shopify.dev/generated/generated_docs_data.json Updates generated docs data to reflect the new “general commands” category.
docs-shopify.dev/generated/generated_category_pages.json Removes the generated “organization” category page entry.
docs-shopify.dev/commands/organization-list.doc.ts Updates the command doc’s category to “general commands”.
docs-shopify.dev/categories/organization.doc.ts Removes the now-unused category template for “organization”.

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

Comment on lines 51 to +52
// Topics that are included in the general commands category
const generalTopics: string[] = ['config', 'auth']
const generalTopics: string[] = ['config', 'auth', 'organization']
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

The categorization behavior here (treating organization as a general topic) isn’t covered by the existing unit tests for the docs generator. Please add a test case that verifies writeCommandDocumentation assigns category: 'general commands' when hasTopic is true and topic is one of generalTopics (e.g., an organization:... command). This will prevent regressions if the topic list or category logic changes later.

Copilot uses AI. Check for mistakes.
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