Juanpprieto/stable sitemap

[juanpprieto]

Update

Stabilize getSitemap, getSitemapIndex and implement on skeleton

Upgrade instructions

1. Update the getSitemapIndex at /app/routes/[sitemap.xml].tsx

- import {unstable__getSitemapIndex as getSitemapIndex} from '@shopify/hydrogen';
+ import {getSitemapIndex} from '@shopify/hydrogen';

2. Update the getSitemap at /app/routes/sitemap.$type.$page[.xml].tsx

- import {unstable__getSitemap as getSitemap} from '@shopify/hydrogen';
+ import {getSitemap} from '@shopify/hydrogen';

For a reference implementation please see the skeleton template sitemap routes:

• sitemap.xml
• sitemap/type/page.xml

PR description

WHY are these changes introduced?

Closes https://github.com/orgs/Shopify/projects/5093/views/16?pane=issue&itemId=79743679 and https://github.com/orgs/Shopify/projects/5093/views/16?pane=issue&itemId=79604624

WHAT is this pull request doing?

1. Stabilizes getSitemap and getSitemapIndex utilities
2. Removes the sitemap example
3. Implements the stable sitemap utilities in the skeleton template

HOW to test your changes?

Visit the /sitemap.xml route and nested sitemap urls

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 or updated the documentation

[shopify]

Oxygen deployed a preview of your juanpprieto/stable-sitemap branch. Details:

Storefront	Status	Preview link	Deployment details	Last update (UTC)
custom-cart-method	✅ Successful (Logs)	Preview deployment	Inspect deployment	October 21, 202411:31 PM
metaobjects	✅ Successful (Logs)	Preview deployment	Inspect deployment	October 21, 202411:31 PM
third-party-queries-caching	✅ Successful (Logs)	Preview deployment	Inspect deployment	October 21, 202411:31 PM
classic-remix	✅ Successful (Logs)	Preview deployment	Inspect deployment	October 21, 202411:31 PM
Skeleton (skeleton.hydrogen.shop)	✅ Successful (Logs)	Preview deployment	Inspect deployment	October 21, 202411:31 PM

Learn more about Hydrogen's GitHub integration.

[jsaubry]

I didn't review the code, but 👍 for

• Removing the example
• Moving to '2024-10' rather than unstable
• Updating the skeleton

[jsaubry]

Looking at the deployments, the XML produced looks legit. However, I tried to follow a link from the metaObject page and got a 404 https://01j9cc8nc12y73gvtmjaar74p0-bdc62392032d96aafe24.myshopify.dev/custom_pages/mono-skis, is that expected?

[juanpprieto]

Ideally this version should not be hardcoded and it should either:
Accepts and sfapiVersion or consume any version passed to our clients constructions via server.ts

[rbshop]

Since this is going out with the 2024-10 release, as I understand it we will no longer need to provide the storefrontApiVersion override to the storefront.query call, so I'll remove this const and rebase this against #2570