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

Bump sitemap from 4.1.1 to 6.0.0 in /docs #10092

Closed

Conversation

dependabot-preview[bot]
Copy link
Contributor

Bumps sitemap from 4.1.1 to 6.0.0.

Release notes

Sourced from sitemap's releases.

Streaming Sitemap + Index

6.0.0

  • removed xmlbuilder as a dependency
  • added stronger validity checking on values supplied to sitemap
  • Added the ability to turn off or add custom xml namespaces
  • CLI and library now can accept a stream which will automatically write both the index and the sitemaps. See README for usage.

6.0.0 breaking changes

  • renamed XMLToISitemapOptions to XMLToSitemapOptions
  • various error messages changed.
  • removed deprecated Sitemap and SitemapIndex classes
  • replaced buildSitemapIndex with SitemapIndexStream
  • Typescript: various types renamed or made more specific, removed I prefix
  • Typescript: view_count is now exclusively a number
  • Typescript: price:type and price:resolution are now more restrictive types
  • sitemap parser now returns a sitemapItem array rather than a config object that could be passed to the now removed Sitemap class
  • CLI no longer accepts multiple file arguments or a mixture of file and streams except as a part of a parameter eg. prepend

baidu support

Fix for #255. Baidu does not like timestamp in its sitemap.xml, this adds an option to truncate lastmod

new SitemapStream({ lastmodDateOnly: true });

fix for validator error

5.0.1

Fix for issue #254.

warning: failed to load external entity "./schema/all.xsd"
Schemas parser error : Failed to locate the main schema resource at './schema/all.xsd'.
WXS schema ./schema/all.xsd failed to compile

Streams

This release is heavily focused on converting the core methods of this library to use streams. Why? Overall its made the API ~20% faster and uses only 10% or less of the memory. Some tradeoffs had to be made as in their nature streams are operate on individual segments of data as opposed to the whole. For instance, the streaming interface does not support removal of sitemap items as it does not hold on to a sitemap item after its converted to XML. It should however be possible to create your own transform that filters out entries should you desire it. The existing synchronous interfaces will remain for this release at least. Do not be surprised if they go away in a future breaking release.

Sitemap Index

This library interface has been overhauled to use streams internally. Although it would have been preferable to convert this to a stream as well, I could not think of an interface that wouldn't actually end up more complex or confusing. It may be altered in the near future to accept a stream in addition to a simple list.

Misc

  • runnable examples, some pulled straight from README have been added to the examples directory.
  • createSitemapsIndex was renamed createSitemapsAndIndex to more accurately reflect its function. It now returns a promise that resolves to true or throws with an error.
  • You can now add to existing sitemap.xml files via the cli using npx sitemap --prepend existingSitemap.xml < listOfNewURLs.json.txt

Breaking Changes

  • Dropped support for mobile sitemap - Google appears to have deleted their dtd and all references to it, strongly implying that they do not want you to use it. As its absence now breaks the validator, it has been dropped.
  • normalizeURL(url, XMLRoot, hostname) -> normalizeURL(url, hostname)
    • The second argument was unused and has been eliminated
  • Support for Node 8 dropped - Node 8 is reaching its EOL December 2019
  • xslURL is being dropped from all apis - styling xml is out of scope of this library.
... (truncated)
Changelog

Sourced from sitemap's changelog.

6.0.0

  • removed xmlbuilder as a dependency
  • added stronger validity checking on values supplied to sitemap
  • Added the ability to turn off or add custom xml namespaces
  • CLI and library now can accept a stream which will automatically write both the index and the sitemaps. See README for usage.

6.0.0 breaking changes

  • renamed XMLToISitemapOptions to XMLToSitemapOptions
  • various error messages changed.
  • removed deprecated Sitemap and SitemapIndex classes
  • replaced buildSitemapIndex with SitemapIndexStream
  • Typescript: various types renamed or made more specific, removed I prefix
  • Typescript: view_count is now exclusively a number
  • Typescript: price:type and price:resolution are now more restrictive types
  • sitemap parser now returns a sitemapItem array rather than a config object that could be passed to the now removed Sitemap class
  • CLI no longer accepts multiple file arguments or a mixture of file and streams except as a part of a parameter eg. prepend

5.1.0

Fix for #255. Baidu does not like timestamp in its sitemap.xml, this adds an option to truncate lastmod

new SitemapStream({ lastmodDateOnly: true });

5.0.1

Fix for issue #254.

warning: failed to load external entity "./schema/all.xsd"
Schemas parser error : Failed to locate the main schema resource at './schema/all.xsd'.
WXS schema ./schema/all.xsd failed to compile

5.0.0

Streams

This release is heavily focused on converting the core methods of this library to use streams. Why? Overall its made the API ~20% faster and uses only 10% or less of the memory. Some tradeoffs had to be made as in their nature streams are operate on individual segments of data as opposed to the whole. For instance, the streaming interface does not support removal of sitemap items as it does not hold on to a sitemap item after its converted to XML. It should however be possible to create your own transform that filters out entries should you desire it. The existing synchronous interfaces will remain for this release at least. Do not be surprised if they go away in a future breaking release.

Sitemap Index

This library interface has been overhauled to use streams internally. Although it would have been preferable to convert this to a stream as well, I could not think of an interface that wouldn't actually end up more complex or confusing. It may be altered in the near future to accept a stream in addition to a simple list.

Misc

  • runnable examples, some pulled straight from README have been added to the examples directory.
... (truncated)
Commits
  • d260283 streaming sitemap and index
  • ef89c7c bump deps
  • 40c8c15 bump deps
  • b7c62f3 bump deps
  • df4d2d6 Merge pull request #105 from derduher/dependabot/npm_and_yarn/babel/plugin-tr...
  • 8e68e85 Bump @babel/plugin-transform-typescript from 7.7.4 to 7.8.3
  • 1b31ca9 Merge pull request #108 from derduher/dependabot/npm_and_yarn/typescript-esli...
  • 660ea5a Merge pull request #107 from derduher/dependabot/npm_and_yarn/typescript-esli...
  • beacd84 Merge pull request #109 from derduher/dependabot/npm_and_yarn/stream-json-1.3.3
  • ccd854d Merge pull request #104 from derduher/dependabot/npm_and_yarn/babel/preset-ty...
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Pull request limits (per update run and/or open at any time)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Bumps [sitemap](https://github.com/ekalinin/sitemap.js) from 4.1.1 to 6.0.0.
- [Release notes](https://github.com/ekalinin/sitemap.js/releases)
- [Changelog](https://github.com/ekalinin/sitemap.js/blob/master/CHANGELOG.md)
- [Commits](ekalinin/sitemap.js@4.1.1...6.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
@dependabot-preview
Copy link
Contributor Author

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot-preview dependabot-preview bot deleted the dependabot/npm_and_yarn/docs/sitemap-6.0.0 branch March 10, 2020 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant