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

feat(gatsby-plugin-sitemap): add siteUrl validation #16329

Merged
merged 6 commits into from Aug 9, 2019

Conversation

doc-han
Copy link
Contributor

@doc-han doc-han commented Aug 2, 2019

Description

This PR is a fix for #15754

  1. Validating siteUrl and throwing an error if it's an empty string
  2. Adding a note to docs to prompt that siteUrl can't be left blank or undefined

Related Issues

Fixes #15754

@doc-han doc-han requested review from a team as code owners August 2, 2019 12:01
@doc-han doc-han changed the title fix(gatsby-plugin-sitemap): fix siteUrl validation feat(gatsby-plugin-sitemap): add siteUrl validation Aug 3, 2019
@doc-han
Copy link
Contributor Author

doc-han commented Aug 3, 2019

Anyone to check this out?

Copy link
Contributor

@wardpeet wardpeet left a comment

Choose a reason for hiding this comment

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

This is awesome! Thank you for taking this up.

Could we change the code to something like

// siteUrl Validation
if (!r.data.site.siteMetadata.siteUrl ||
  r.data.site.siteMetadata.siteUrl == null ||
  r.data.site.siteMetadata.siteUrl.trim().length == 0
) {
  throw new Error(
    `SiteMetaData 'siteUrl' property is required and cannot be left empty. Check out the documentation to see a working example: https://www.gatsbyjs.org/packages/gatsby-plugin-sitemap/#how-to-use`
  )
}

Copy link
Contributor

@sidharthachatterjee sidharthachatterjee 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 adding this!

@sidharthachatterjee sidharthachatterjee added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Aug 9, 2019
@gatsbybot gatsbybot merged commit 9f3d71d into gatsbyjs:master Aug 9, 2019
@gatsbot
Copy link

gatsbot bot commented Aug 9, 2019

Holy buckets, @doc-han — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
  2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

gatsby-plugin-sitemap does not throw error if siteUrl is not filled
4 participants