Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sitemap should only include page routes #7656

Merged
merged 6 commits into from
Jul 17, 2023
Merged

Sitemap should only include page routes #7656

merged 6 commits into from
Jul 17, 2023

Conversation

natemoo-re
Copy link
Member

@natemoo-re natemoo-re commented Jul 14, 2023

Changes

This is a MAJOR (breaking) change that will bump @astrojs/sitemap to 2.0.0!

  • Ensures that @astrojs/sitemap only includes page routes
  • Fix @astrojs/sitemap 1.3.1 adds endpoints with trailing slash #7080. See that issue for more details. Our documentation refers to the sitemap as generating a sitemap from your pages, but all routes were erroneously included. This behavior did not match user expectations and non-page routes needed to be filtered out manually.

Testing

Our tests only covered pages, I added an endpoint and redirect to the suite.

Docs

This change aligns with our existing docs for this package

@changeset-bot
Copy link

changeset-bot bot commented Jul 14, 2023

🦋 Changeset detected

Latest commit: 44417b4

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

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Jul 14, 2023
@natemoo-re natemoo-re requested a review from a team July 14, 2023 19:30
@natemoo-re
Copy link
Member Author

Flagging this for @withastro/maintainers-docs just in case there are concerns!

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks for checking in with docs @natemoo-re !

Reminder: this PR does not update the README (which may be fine!)

Here is how the README introduces the sitemap integration. Are you still comfortable with this description? (I'll point out that it does NOT strictly say page routes in the very first line, even though that may be the expectation.)

I'm happy to sign off and approve here, and will leave it to you to confirm that you still believe the README intro presents this integration accurately. If not, then update as you see fit! 🙌

Screenshot from 2023-07-17 15-53-23

@natemoo-re natemoo-re merged commit dd931a7 into main Jul 17, 2023
13 checks passed
@natemoo-re natemoo-re deleted the fix/7080--plt-552 branch July 17, 2023 20:29
@astrobot-houston astrobot-houston mentioned this pull request Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

@astrojs/sitemap 1.3.1 adds endpoints with trailing slash
5 participants