Mity Docs Mity Docs for Mity Digital
Sitemapamic Documentation

Upgrade

You can upgrade Sitemapamic using composer - it's as easy as that.

For major versions, you will need to manually increment version numbers as these may include breaking changes and may need some additional changes to your code.

2.x to 3.x New

v3 drops support for Statamic 3.3 and Statamic 4.

Update the following dependencies in your site's composer.json file:

  • mitydigital/sitemapamic to ^3.0

v2.x to v2.3.8

This update adds support for mapping your own field handles to Sitemapamic's expected fields. This is for:

  • whether to include or exclude an entry from the sitemap,

  • change frequency, and

  • priority

If you are happy to use Sitemapamic's opinionated Blueprint Requirements (or you already are), there's nothing for you to do.

If you want to have your own Blueprint Fields, check out the configuration options, or the source config file for full details.

v2.1 to v2.2.0

This update adds new features, and unless you want to use them, requires no additional changes.

If you'd like to use the new multiple sitemaps option, you'll need to add the mode property set to multiple to your Sitemapamic config file.

Check out the configuration options, or the source config file for full details.

v2.2.0 also adds support for clearing the cache for sub-sections of your grouped sitemaps using the please utility. This only applies when you have your mode set to multiple. See Clearing the Cache for more details.

v2.1 to v2.1.1

If you'd like to use the new TTL config option, you'll need to add the ttl property to your Sitemapamic config file.

Check out the configuration options, or the source config file for full details.

v2.0 to v2.1

This most likely won't need your attention, but the SitemapUrl class has been renamed to SitemapamicUrl, and the function arguments are now named, not an anonymous array.

v2.1 also introduces the ability to:

  • include global Taxonomy Terms

  • include dynamic routes

To take advantage of the global Taxonomy Terms, you'll need to add the globals property to your config file. Take a look at the package's default config file for an example.

Refer to the documentation above for more details about implementing both features.

v1.0 to v2.0

When upgrading to v2.0+, if you've published the view, manually check to see if anything needs tweaking.

If you're using the command in your deployment script or as a daily job, please update the command:

1# Before
2php please sitemap-cache:clear
3 
4# After
5php please sitemapamic:clear

You may also want to update your composer.json file to use the new package name:

1# Before
2"mitydigital/statamic-xml-sitemap": "^1.0",
3 
4# After
5"mitydigital/sitemapamic": "^2.0",