It's been nearly a year since the last Sitemap release, and there have been 3 bug-fixes, 2 new features, and a bunch of tasks to make development and maintenance easier.

Upgrade instructions

Please note that this release contains a database update, sitemap_update_8205() which modifies configuration. If you are using Configuration Management, then you will need to run the database update and then immediately export configuration (otherwise you may get an error). We suggest the following workflow:

  1. On your local environment:
    1. Run composer update -w drupal/sitemap to update the sitemap module's code
    2. Run drush updatedb or update.php to run database updates
    3. Run drush config:export or export config from the UI to capture the configuration changes made by sitemap_update_8205()
    4. Commit the changes to sitemap.settings.yml and composer.lock
      • Note: if you don't have a Menu sitemap plugin configured, or you applied the patch from [#3032084], there may be no changes to sitemap.settings.yml: this is expected
    5. Push your new commit
  2. Afterwards, on other copies of the site:
    1. Pull the new commit
    2. Run composer install to update the sitemap module's code
    3. Run drush -y deploy, or run database updates and then import configuration through the UI

This procedure is documented in the official instructions, but I find gbyte's article on In which order should be Drupal updates and configuration import/export run? to be a bit easier to reference.

Changes since version 8.x-2.0

  1. task: Add a .editorconfig by @mparker17
  2. task: Fix issues identified by phpcs in GitLab CI by @mparker17
  3. task: Update CI config to test on D10, D11 by @mparker17
  4. task: Remove fields that project_composer populates by @mparker17
  5. task: Update description to match project browser summary by @mparker17
  6. task: Fix D11 tests by updating the core_version_requirement in the sitemap_custom_plugin_test submodule by @mparker17
  7. task: Add book to test_dependencies for tests by @mparker17
  8. task: Add test_dependencies to root module, instead of submodule by @mparker17
  9. task: Add drupal/book 1 or 2 to require-dev for tests by @mparker17
  10. task: Fix indentation in composer.json by @mparker17
  11. task: Disable upgrade status job because D12 is a while away by @mparker17
  12. task: [#3500618] by @berramou
  13. feat: [#3032084] by @tom konda, @welly, @ikouoh, @nexusnovaz, @smustgrave, @akalata, and @mparker17
  14. task: Install Drush: it makes local development easier by @mparker17
  15. task: Use ddev/ddev-drupal-contrib to develop the sitemap module by @mparker17
  16. task: Fix phpstan @covers value \sitemap_update_*() references an invalid class or function error by @mparker17
  17. feat: [#3540861] by @mparker17
  18. fix: [#3540848] by @jernejmramor, and @mparker17
  19. task: Upgrade ddev/ddev-drupal-contrib to 1.1.3.
  20. task: [#3541413] by @mparker17
  21. fix: [#3541553] by @mparker17
  22. fix: [#3537538] by @programeta, and @dhruv.mittal

Thank you

This release wouldn't have been possible without support from the Drupal Community, especially my co-maintainer @akalata, and other community members @berramou, @dhruv.mittal, @ikouoh, @jernejmramor, @nexusnovaz, @programeta, @smustgrave, @tom konda, and @welly, all of whom contributed to this release!

My employers/clients Ontario Digital Service, Brady's Meat & Deli, and Consensus Enterprises also deserve credit for sponsoring time for me to maintain this module!

VCS Label
8.x-2.1
Core compatibility
Release type
Short description
3 bug-fixes, 2 new features, and tasks to make maintenance easier
Packaged Git sha1
2d14489496d68cf9304d573ec2691be893561ef9
Release files