Sitemapamic Release Notes

What's Changed

• Listen for ScheduledCacheInvalidated event by @martyf in https://github.com/mitydigital/statamic-sitemapamic/pull/25

What's Changed

• Allow computed value for configs by @wuifdesign in https://github.com/mitydigital/statamic-sitemapamic/pull/22

New Contributors

• @wuifdesign made their first contribution in https://github.com/mitydigital/statamic-sitemapamic/pull/22

Full Changelog: https://github.com/mitydigital/statamic-sitemapamic/compare/3.0.2...3.1.0

Fixes https://github.com/mitydigital/statamic-sitemapamic/issues/21 by forcing the external url (ArrayableLink) to be a string.

Remove all references to old Site configuration

Support for Statamic 5 Drops support for Statamic 3 and 4.

Removed Statamic 5 support. This will be a major update to 3.0.0 (will be tagged shortly)

Corrects an issue (#18) when submit routes were created when single mode was defined.

Adds support for field mappings.

Refer to the revised default config file for the new mappings key that allows you to map Statamic's opinionated field handles with fields of your own:

    /*
    |--------------------------------------------------------------------------
    | Field mappings
    |--------------------------------------------------------------------------
    |
    | Allows you to map your blueprint fields with what Sitemapamic is expecting for controlling
    | the change frequency, inclusion and priority.
    |
    */
    'mappings' => [
        'include' => 'meta_include_in_xml_sitemap',
        'change_frequency' => 'meta_change_frequency',
        'priority' => 'meta_priority',
    ]

If you have your own fields, such as "sitemap_include", "sitemap_change_frequency" and "sitemap_priority", your config file needs:

    'mappings' => [
        'include' => 'sitemap_include',
        'change_frequency' => 'sitemap_change_frequency',
        'priority' => 'sitemap_priority',
    ]

If you don't want to change use the mappings, that's cool: there's nothing to do. Your existing setups will function as they always have.

So hurtful that you want to leave... and just to visit some other site?

Well fine then, I suppose entries with a "link" blueprint (automagically created by Statamic), that have a "redirect" property, and link to an external URL should be excluded from the sitemaps.

See Issue #12.

Hello, handsome. And we're talking to you, Statamic 4.

A logic update here which may impact your expected behaviour.

Prior to this update, past/future entries that were configured to be 'unlisted' were incorrectly included in Sitemapamic.

This update corrects this behaviour: only 'public' entries are shown: 'unlisted' and 'private' entries are not included when they are not visible on the main site itself.

Just a typo update, nothing too exciting here.

Updated composer to require PHP 8.1

If you're using our opinionated blueprint for your metadata fields, you may find that "Use default" is resulting in nothing being selected.

This update now allows you to use 'default' as the meta_include_in_xml_sitemap's default key. Using an empty string was too vague.

Well just a small one... 2.3.0's revised cache keys were not listed correctly when you had a single site and a single sitemap. It still cached - but the new list command was showing the wrong key.

This update corrects this.

We started a new multi-site project and needed better multi-site support in Sitemapamic. And now we're sharing this update with you too!

What's new: - full support for multi-site - new sitemapamic:list command

v2.3.0 improves support for multi-site Statamic sites, offering distinct sitemap creation and caching for multi-site configurations that are either on the same domain (i.e. a /en-au/ path on your main domain), or on an entirely different domain (i.e. https://en-au.your-domain.com).

This update keeps full support for sub-sitemaps too, introduced in v2.2.0.

We've also done some under-the-hood caching updates, and added a new sitemapamic:list command if you wanted to see what cache keys are available for you to individually clear.

Adds support for splitting a large sitemap in to multiple sitemaps based on your collection and taxonomy routes. Thanks @jacksleight for this.

If you're not planning on using this feature, there's nothing for you to do.

By default, your existing setup will still work and create a single sitemap with all routes. To use multiple sitemaps, add the mode attribute to your config, and set it to multiple. See Configuration Options.

Also added is the ability to clear sub-sitemaps. See Clearing the cache.

Just a minor update to add a ttl config option if you'd like to have your Sitemapamic cache cleared more frequently.

The default is 'forever' - meaning until an Entry, Term, Taxonomy or Collection is changed.

With this update, you can now add ttl to your config file, and have your cache live for a set period of time.

Check out the source config file for full notes.

Welcome to a new day, and a new release.

This release adds a few new features: - support for global Taxonomy Term URLs - support for adding your own Dynamic Routes.

Check out the README for full details

This release also updates the events that trigger the sitemap cache to clear. The cache will be cleared automatically when any of the following are saved or deleted: - Entry - Term - Taxonomy (added in 2.1.0) - Collection (added in 2.1.0)

Finally, the SitemapUrl class has been renamed to SitemapamicUrl - there's a high chance you have not used this class yourself, but just in case you have, make sure you update your code too.

Just a little housekeeping update - the config file is cleaned up and now lives in config/sitemapamic.php.

The upgrade process will try to move it for you.

Also added: when an Entry or Term is deleted, the Sitemapamic cache is cleared. Previously it was just on save.

You can also now publish the XML view template too - just in case you need to make changes - check out the readme for more details.

Hello Sitemapamic! You're the shiny new name for the "XML Sitemap generator for Statamic". Much nicer, hey?

This is a v2.0 update that does introduce breaking changes. Review the upgrade notes in the readme for full details of how to go from v1.x to v2.0. It's really easy, but just give it a read.

Just some minor code clean ups with the slight tweak to the name. Also improved the readme details.

Just a small one: moved the XML header to the controller (rather than the blade template) as it is creating issues with some users with PHP short tags enabled.

Tweak behaviour for terms and multi-sites

Caching improvements for multi-site setups

Improved handling of multi-site sitemap generation

Adds support for including/excluding Taxonomy URLs per collection.

Adds a new config option, includeTaxonimies, such as:

'blog' => [
    'include'           => true,
    'frequency'         => 'monthly',
    'priority'          => '0.6',
    'includeTaxonomies' => false,
],

When enabled, Taxonomy URLs will be included in the sitemap. This is the default behaviour, even if you do not add this property (i.e. you're upgrading from an earlier version).

When disabled, Taxonomy URLs for that Collection will be disabled. If the Collection itself is disabled, the Taxonomy URLs will be disabled too.

Adding this property to your config file is recommended.

New installations also only come pre-configured with a single Pages Collection, just for easier on-boarding.

This update provides changes to the way entries and terms are processed, and corrects a few issues.

Firstly, the Sites URL for an Entry/Term locale is used for the root - not just the app URL.

Secondly, only Collections defined in the sitemap.php config file are looked at. It makes sense to only look at Collections that you actually want to have included, right? Happy to discuss this point, but does make sense - although the config key should probably change from "defaults" to "collections" or something - but that's more breaking so can come later.

Added support for PHP short tags on the base template.

Fixed an issue with excluding a specific Entry from the sitemap

Adds a fix for a crash for tags that are not used with any entries

Initial release of a simple sitemap generator for Statamic 3 for my personal use. But thought installing via composer would be handy.