Skip to content

Conversation

@juanpprieto
Copy link
Contributor

@juanpprieto juanpprieto commented Aug 13, 2025

WHY are these changes introduced?

API updates are complex, touching multiple packages and requiring careful coordination. This command guide eliminates common errors and ensures consistent updates across quarterly API releases.

WHAT is this pull request doing?

Adds a comprehensive Claude CLI command guide (.claude/commands/apis-version-update.md) for updating Storefront and Customer Account API versions.

The command provides:

  • Step-by-step process with validation checkpoints
  • Automated type generation and package building
  • Error analysis and resolution guidance
  • GitHub issue and PR template generation

Key improvements:

  • Explains critical steps (e.g., why hydrogen-react build is mandatory)
  • Provides fallback procedures for common issues
  • Clarifies version bump logic for each package
  • Includes search commands for finding hardcoded references

HOW to test your changes?

  1. Checkout this branch
  2. Run Claude CLI: claude
  3. Execute: /apis-version-update
  4. Follow the guided process for updating API versions

The command will walk through determining target version, updating constants, generating types, validating changes, and creating changesets.

Checklist

  • I've read the Contributing Guidelines
  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've added a changeset if this PR contains user-facing or noteworthy changes
  • I've added tests to cover my changes
  • I've added or updated the documentation

@shopify
Copy link
Contributor

shopify bot commented Aug 13, 2025

Oxygen deployed a preview of your juanpprieto/api-update-command branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
Skeleton (skeleton.hydrogen.shop) ✅ Successful (Logs) Preview deployment Inspect deployment August 15, 2025 4:51 PM
custom-cart-method ✅ Successful (Logs) Preview deployment Inspect deployment August 15, 2025 4:51 PM
third-party-queries-caching ✅ Successful (Logs) Preview deployment Inspect deployment August 15, 2025 4:51 PM
metaobjects ✅ Successful (Logs) Preview deployment Inspect deployment August 15, 2025 4:51 PM

Learn more about Hydrogen's GitHub integration.

@juanpprieto juanpprieto reopened this Aug 13, 2025
This adds a comprehensive guide for updating API versions in Hydrogen. The command provides:
- Step-by-step process for quarterly API updates
- Automated type generation and validation
- GitHub issue creation for tracking changes
- PR template generation with validation status
- Error analysis and resolution guidance

To use in Claude CLI: /apis-version-update
- Add quick summary with 10 clear sequential steps at the beginning
- Integrate TODO tracking instructions throughout each step
- Reorganize content with improved step numbering and flow
- Add required GitHub issue creation step with detailed implementation
- Include automated issue creation from API changelog data
- Add pre-commit verification checklist to ensure all steps completed
- Enhance cleanup section with comprehensive temporary file removal
- Improve checkpoint summaries for better progress tracking
- Clarify distinction between required and conditional steps
- Add validation checks for GitHub issues, changesets, and temp files
@juanpprieto juanpprieto force-pushed the juanpprieto/api-update-command branch from 4229e74 to cba1c15 Compare August 15, 2025 16:48
@juanpprieto juanpprieto merged commit eb4ba09 into main Aug 15, 2025
11 checks passed
@juanpprieto juanpprieto deleted the juanpprieto/api-update-command branch August 15, 2025 16:57
juanpprieto added a commit that referenced this pull request Sep 17, 2025
* Add Storefront and Customer Account API version update command

This adds a comprehensive guide for updating API versions in Hydrogen. The command provides:
- Step-by-step process for quarterly API updates
- Automated type generation and validation
- GitHub issue creation for tracking changes
- PR template generation with validation status
- Error analysis and resolution guidance

To use in Claude CLI: /apis-version-update

* Improve API version update guide with enhanced structure and clarity

- Add quick summary with 10 clear sequential steps at the beginning
- Integrate TODO tracking instructions throughout each step
- Reorganize content with improved step numbering and flow
- Add required GitHub issue creation step with detailed implementation
- Include automated issue creation from API changelog data
- Add pre-commit verification checklist to ensure all steps completed
- Enhance cleanup section with comprehensive temporary file removal
- Improve checkpoint summaries for better progress tracking
- Clarify distinction between required and conditional steps
- Add validation checks for GitHub issues, changesets, and temp files

* chore: re-trigger CI to clear potential cache issues
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.

1 participant