fix(gatsby-plugin-sitemap): Properly throw error on missing siteUrl #31963
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LekoArts
added
the
topic: plugins
gatsbot
bot
added
the
status: triage needed
LekoArts
changed the title
LekoArts
removed
the
status: triage needed
LekoArts
commented
Jun 17, 2021
| @@ -34,8 +34,8 @@ export function resolveSiteUrl(data) { | |||
| if (!data?.site?.siteMetadata?.siteUrl) { | |||
| throw Error( | |||
| `\`siteUrl\` does not exist on \`siteMetadata\` in the data returned from the query. | |||
| Add this to your custom query or provide a custom \`resolveSiteUrl\` function. | |||
| https://www.gatsbyjs.com/plugins/gatsby-plugin-sitemap/#api-reference | |||
| Add this to your \`siteMetadata\` object inside gatsby-config.js or add this to your custom query or provide a custom \`resolveSiteUrl\` function. | |||
There was a problem hiding this comment.
Fixing indentation in this file
LekoArts
commented
Jun 17, 2021
| @@ -1,4 +1,7 @@ | |||
| module.exports = { | |||
| siteMetadata: { | |||
| siteUrl: `https://www.yourdomain.tld`, | |||
There was a problem hiding this comment.
create-gatsby doesn't have the ability (yet) to define siteMetadata data for each plugin so for now this must be in here for everything (even when doesn't use sitemap plugin)
This was referenced Jun 23, 2021
This was referenced Jan 18, 2022
This was referenced Oct 28, 2023
This was referenced Jan 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Since the
resolvePagesfunction was before theresolveSiteUrlfunction it couldn't throw the error about missingsiteUrl. We also didn't show GraphQL errors if there were ones that we didn't account for. So I've added logging forerrors, too. Lastly, I've addedsiteUrlto our default and minimal starter.Documentation
I've updated the README a bit.
Related Issues
Fixes #31903
[ch32958]