Skip to content
This repository has been archived by the owner on Mar 7, 2020. It is now read-only.

Renovate: Update dependency sitemap to v5 #13

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Oct 26, 2019

This PR contains the following updates:

Package Type Update Change
sitemap dependencies major 2.2.0 -> 5.0.1

Release Notes

ekalinin/sitemap.js

v5.0.1

Compare Source

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

v5.0.0

Compare Source

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.
  • createSitemapIndex has been converted to a promised based api rather than callback.
  • createSitemapIndex now gzips by default - pass gzip: false to disable
  • cacheTime is being dropped from createSitemapIndex - This didn't actually cache the way it was written so this should be a non-breaking change in effect.
  • SitemapIndex as a class has been dropped. The class did all its work on construction and there was no reason to hold on to it once you created it.
  • The options for the cli have been overhauled
    • --json is now inferred
    • --line-separated has been flipped to --single-line-json to by default output options immediately compatible with feeding back into sitemap

v4.1.1

Compare Source

Add a pretty print option to toString(false)
pass true pretty print

Add an xmlparser that will output a config that would generate that same file

cli:
use --parser to output the complete config --line-separated to print out line
separated config compatible with the --json input option for cli

lib: import parseSitemap and pass it a stream

v4.0.2

Compare Source

Fix npx script error - needs the shebang

v4.0.1

Compare Source

Validation functions which depend on xmllint will now warn if you do not have xmllint installed.

v3.2.2

Compare Source

  • revert https everywhere added in 3.2.0. xmlns is not url.
  • adds alias for lastmod in the form of lastmodiso
  • fixes bug in lastmod option for buildSitemapIndex where option would be overwritten if a lastmod option was provided with a single url
  • fixes #​201, fixes #​203

v3.2.1

Compare Source

  • no really fixes ts errors for real this time
  • fixes #​193 in PR #​198

v3.2.0

Compare Source

  • fixes #​192, fixes #​193 typescript errors
  • correct types on player:loc and restriction:relationship types
  • use https urls in xmlns

v3.1.0

Compare Source

v3.0.0

Compare Source

  • Converted project to typescript
  • properly encode URLs #​179
  • updated core dependency
breaking changes

This will likely not break anyone's code but we're bumping to be safe

  • root domain URLs are now suffixed with / (eg. https://www.ya.ru -> https://www.ya.ru/) This is a side-effect of properly encoding passed in URLs

Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or if you modify the PR title to begin with "rebase!".

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot. View repository job log here.

@codecov
Copy link

codecov bot commented Oct 26, 2019

Codecov Report

Merging #13 into master will increase coverage by 6.66%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #13      +/-   ##
==========================================
+ Coverage   86.66%   93.33%   +6.66%     
==========================================
  Files           2        2              
  Lines          15       15              
  Branches        3        3              
==========================================
+ Hits           13       14       +1     
+ Misses          2        1       -1
Impacted Files Coverage Δ
lib/sitemap/sitemap.ts 92.3% <0%> (+7.69%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f4a2da1...12b23bb. Read the comment docs.

@renovate
Copy link
Author

renovate bot commented Oct 27, 2019

PR has been edited

👷 This PR has received other commits, so Renovate will stop updating it to avoid conflicts or other problems. If you wish to abandon your changes and have Renovate start over you may click the "rebase" checkbox in the PR body/description.

@renovate
Copy link
Author

renovate bot commented Mar 7, 2020

Autoclosing Skipped

This PR has been flagged for autoclosing, however it is being skipped due to the branch being already modified. Please close/delete it manually or report a bug if you think this is in error.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants