Add option to prefix sitemap

[ktym4a]

Changes

Google Serach Console sometimes not work by sitemap-*.xml, so add an option to change the file name.
ekalinin/sitemap.js#395

Follow this one with Want to customize that? section.
https://github.com/ekalinin/sitemap.js?tab=readme-ov-file#create-sitemap-and-index-files-from-one-large-list

Testing

Add prefix.test.js.
Test the content is the same with and without the prefix option.
Test the link is in *-index.xml correct.

Docs

Docs need to be updated, because there are more options

[changeset-bot]

🦋 Changeset detected

Latest commit: 902826f

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[ktym4a]

I'm sure that prefix need to be checked for correct input.
Should I check in schema.ts and if input is not correct, pass undefined and set sitemap-? (I mean I set sitemap- for default)

astro/packages/integrations/sitemap/src/index.ts

Line 83 in b596506

const { filter, customPages, serialize, entryLimit, prefix = 'sitemap-' } = opts;

and Is it okay that I use /^[a-zA-Z\-_]+$/ for check characters?

also Do you think prefix is a good name for this option?

[ematipico]

Google Serach Console sometimes not work by sitemap-*.xml

Do you have a link that explains this?

[ktym4a]

@ematipico
I have not seen something from official, but the same issue is listed below.
https://beiznotes.org/how-to-avoid-the-0-discovered-urls-bug-in-search-console/
ekalinin/sitemap.js#395

and I try like this to see, if filename is not sitemap-${i}.xml then work.
https://ktym4a.me/sitemap-index.xml (Discovered pages: 0) copy to https://ktym4a.me/sitemap-aa.xml and change url sitemap-0.xml to sitemap-a.xml (Discovered pages: 6)
https://ktym4a.me/sitemap-0.xml (Couldn't fetch) copy to https://ktym4a.me/sitemap-a.xml (Discovered pages: 6)

But, this bug is really strange, that I have two static sites with astro and one works correctly with sitemap-index.xml and sitemap-0.xml.

PS. I only deploy sitemap-index.xml and sitemap-0.xml now
if need to check rename ver, I can deploy them again.

[ktym4a]

also this one
https://www.seroundtable.com/google-fetch-process-sitemap-file-31042.html

[ktym4a]

I tested again now.

default
https://ktym4a.me/sitemap-index.xml (Discovered pages: 0)
https://ktym4a.me/sitemap-0.xml (Couldn't fetch)

change ktym4a-*
https://ktym4a.me/ktym4a-index.xml (Discovered pages: 0)
https://ktym4a.me/ktym4a-0.xml (Couldn't fetch)

change sitemap_*
https://ktym4a.me/sitemap_index.xml (Discovered pages: 6)
https://ktym4a.me/sitemap_0.xml (Discovered pages: 6)

[ematipico]

The changes look good. I will ask docs to review the changelog. Usually, when we add a new feature, we also want to explain that with some code snippet.

[ktym4a]

Thanks for review.

Is there anything else I need do besides these tasks?

• change patch to minor.
• change node:test instead of Mocha.

and how about this one?

I'm sure that prefix need to be checked for correct input. Should I check in schema.ts and if input is not correct, pass undefined and set sitemap-? (I mean I set sitemap- for default)

astro/packages/integrations/sitemap/src/index.ts

Line 83 in b596506

const { filter, customPages, serialize, entryLimit, prefix = 'sitemap-' } = opts;

and Is it okay that I use /^[a-zA-Z\-_]+$/ for check characters?

also Do you think prefix is a good name for this option?

[sarah11918]

Hi @ktym4a -- I'm here to help with docs!

I'll make a suggestion for the changeset message for the kind of message we would expect here, and then you can fix it as necessary.

There should also be a PR made to the docs repo to update this page/section that matches the other configuration options: https://docs.astro.build/en/guides/integrations-guide/sitemap/#configuration

When you make that PR, please fill out the template for adding a new feature to Astro v4.4 and include a link to this PR so we keep them organized together. Don't worry if that PR will need editing, I'll be there to help too! Just try to get it started similar to the other configuration options there. It doesn't need to be fancy, just follow the existing ones as a guide.

[sarah11918]

Hi @ktym4a !

This is an example of what we would normally have here! Since you are the expert in the feature, I will need you to make this actually correct and fix anything. But, I think it would be nice to have this level of detail here.

You could also maybe add a sentence at the end like:

This option is useful when...

But that's up to you!

[ematipico]

Thanks for review.

Is there anything else I need do besides these tasks?

* [x]  change `patch` to `minor`.

* [x]  change `node:test` instead of `Mocha`.

and how about this one?

I'm sure that prefix need to be checked for correct input. Should I check in schema.ts and if input is not correct, pass undefined and set sitemap-? (I mean I set sitemap- for default)

astro/packages/integrations/sitemap/src/index.ts

Line 83 in b596506

const { filter, customPages, serialize, entryLimit, prefix = 'sitemap-' } = opts;

and Is it okay that I use /^[a-zA-Z\-_]+$/ for check characters?
also Do you think prefix is a good name for this option?

I think you are fine, and you don't need to add anything else. The options schema already checks the validity of the input, and I think we don't need to put stricter checks in place.

[ktym4a]

@ematipico
I did not explain well enough, sorry.
The reason I told it is because if someone sets like this, it will be created outside of the output directory.

export default defineConfig({
  integrations: [sitemap({
    prefix: '../a-'
  })]
})

I mean I didn't add/change anything for SitemapOptionsSchema

[ematipico]

Oh, I understand now. Yeah, it's a very edge case. If you're up to the task, feel free to add some level of validation, but I wouldn't worry too much if you don't want to implement it. I think it's fine like this too. It's a very edge case if a user decides to use this "trick"; they can report it and just put a plain string without paths-like characters.

[ktym4a]

I added it because I personally think it should be there.

[sarah11918]

Approving this PR on behalf of docs! Thank you for this helpful contribution @ktym4a 🙌

(And I can see another PR in the docs repo, so I'll get to that one soon)

[sarah11918]

I've already approved here, but I'll also note so it's clear here that the accompanying Docs PR has been approved, so docs is ready whenever you decide to release a new version of @astrojs/sitemap!