[18.0][ADD] website_exclude_sitemap by edescalona · Pull Request #1177 · OCA/website

edescalona · 2026-04-17T22:58:06Z

T21540

Context

Odoo includes every public website URL in the generated sitemap. Some of those URLs are useful for direct navigation but add little or no SEO value when exposed in /sitemap.xml (/livechat, feeds, apply forms, user profiles...). This module keeps the sitemap focused on strategic public pages while leaving normal website access untouched.

What it does

Adds a per-website sitemap_excluded_paths text field, editable from Website > Configuration > Settings > Sitemap Exclusions.
Overrides website._enumerate_pages() to drop the entries whose path matches one of the configured patterns.
Clears the cached sitemap attachments when the exclusions change, when website.page records are created or deleted, and when their url, website_published, website_indexed, date_publish or website_id changes.
Adds a Reload Sitemap button to clear the sitemap cache of the current website manually.

The module only affects sitemap generation: it does not unpublish pages, change access rights, or block direct access to the excluded URLs.

Pattern syntax

Values are separated by line breaks, commas or semicolons; lines starting with # are comments.

Pattern	Matches	Does not match
`/livechat`	`/livechat`	`/livechat/room`
`/customers/`	`/customers`, `/customers/acme`, `/customers/acme/2024`	`/customers-list`
`/blog/*/feed`	`/blog/news/feed`	`/blog/a/b/feed`, `/blog/news`
`/solutions*`	`/solutions`, `/solutions-cloud`	`/solutions/cloud`
`/jobs/**`	`/jobs`, `/jobs/apply/1`, `/jobs/a/b/c`	`/jobs-list`

* matches inside a single path segment and never crosses a /.
** crosses /, matching any number of segments.
A pattern ending in / or /** is a prefix: it excludes that path and everything below it.
Any other pattern matches that exact path; the trailing slash of the URL is ignored.

The default value only covers paths present in any Odoo website (/customers/, /livechat, /blog/*/feed, /jobs/apply/, /profile/); deployment-specific paths are meant to be added by the administrator.

Implementation notes

Patterns are compiled to regexes cached with tools.ormcache keyed on the raw exclusions text, so they are compiled once per configuration instead of once per sitemap entry.
write() on website clears the registry cache when sitemap_excluded_paths changes, so the compiled patterns are invalidated too.
Sitemap cache clearing removes the /sitemap-<website_id>-% binary attachments.
Pages without website_id (shared across websites) invalidate the sitemap cache of every website.

github-actions · 2026-08-23T12:51:37Z

There hasn't been any activity on this pull request in the past 4 months, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 30 days.
If you want this PR to never become stale, please ask a PSC member to apply the "no stale" label.

rrebollo

please consider my suggestions

edescalona · 2026-09-10T20:29:29Z

Hi @rrebollo , thanks for the review; the suggestions have been applied. @pedrobaeza

rrebollo

Code Review. LGTM!

pedrobaeza · 2026-09-11T05:59:36Z

Odoo already allows to control which pages are published:

so I don't get the sense of this.

edescalona · 2026-09-11T13:56:31Z

Hi @pedrobaeza , thanks for the review. That column only affects website.page records, but the goal is to also control controller routes, which cannot be managed via the UI.

For example, with website_customer and website_blog installed, /sitemap.xml contains 45 URLs, but only one (/contactus) originates from a page. The other 44 come from controllers: /customers and its 21 routes (e.g.,
/customers/industry/..., /partners/...), /blog/<blog>/feed, /website/info, etc.

Furthermore, the standard core toggle works on a record-by-record basis, whereas here, a pattern like /customers/ or /blog/*/feed covers entire families of URLs, including those created later.

I’ve added a test (test_enumerate_pages_skips_excluded_controller_urls) that takes an enumerated URL lacking a website.page record and verifies that the pattern excludes it from the sitemap.

Does that make sense to you, or do you see another way to handle this case?

pedrobaeza · 2026-09-11T14:11:00Z

Well, on blogs you can also mark to not track, but OK if you consider the accelerator for the main path. The problem I see with this is the UI, as if you go to the blog page/category and mark to track or not, will contradict this supra configuration.

edescalona · 2026-09-11T15:13:41Z

@pedrobaeza I could add a note in the settings explaining that the list takes precedence over the per-record markup—and also affects the website.page view—though this wouldn't apply to the blog in this module because it would introduce unwanted dependencies. Alternatively, I could mention in description.md that this module overrides the markup. Which option do you think is best?

pedrobaeza · 2026-09-11T15:16:32Z

OK, just mention it in the ROADMAP.md file and let people to decide.

Let website administrators exclude public URLs from /sitemap.xml through a per-website list of paths or glob patterns, configured in Website > Configuration > Settings. Only sitemap generation is filtered: pages stay published and directly accessible. The sitemap cache is cleared when the exclusions or the website pages change, and a Reload Sitemap button clears it manually.

edescalona · 2026-09-11T15:31:28Z

ready @pedrobaeza

pedrobaeza · 2026-09-11T15:35:51Z

OK, a second review is needed.

rrebollo

Code Review. LGTM!

jelenapoblet

This module solves a problem we have been dealing with for a long time: customizing the sitemap without modifying Odoo’s standard files.
I wasn't even aware you where working on this, I was modifying the sitemap manually with the marketing team all the time.
LGTM

edescalona · 2026-09-16T18:28:11Z

Ready @pedrobaeza Can we merge now?

OCA-git-bot · 2026-09-16T19:00:03Z

This PR has the approved label and has been created more than 5 days ago. It should therefore be ready to merge by a maintainer (or a PSC member if the concerned addon has no declared maintainer). 🤖

pedrobaeza · 2026-09-17T06:43:06Z

/ocabot merge nobump

OCA-git-bot · 2026-09-17T06:43:15Z

This PR looks fantastic, let's merge it!
Prepared branch 18.0-ocabot-merge-pr-1177-by-pedrobaeza-bump-nobump, awaiting test results.

OCA-git-bot · 2026-09-17T06:49:16Z

@pedrobaeza The merge process could not be finalized, because command twine upload --disable-progress-bar --non-interactive --repository-url https://upload.pypi.org/legacy/ -u __token__ odoo_addon_website_exclude_sitemap-18.0.1.0.0.1-py3-none-any.whl failed with output:

Uploading distributions to https://upload.pypi.org/legacy/
Uploading odoo_addon_website_exclude_sitemap-18.0.1.0.0.1-py3-none-any.whl
�[33mWARNING �[0m Error during upload. Retry with the --verbose option for more details. 
�[31mERROR   �[0m HTTPError: 429 Too Many Requests from https://upload.pypi.org/legacy/  
         Too Many Requests

pedrobaeza · 2026-09-17T06:51:01Z

@OCA/pypi-support to reserve the name

sbidoul · 2026-09-17T07:55:17Z

Name reserved

pedrobaeza · 2026-09-17T08:02:29Z

/ocabot merge nobump

OCA-git-bot · 2026-09-17T08:02:39Z

This PR looks fantastic, let's merge it!
Prepared branch 18.0-ocabot-merge-pr-1177-by-pedrobaeza-bump-nobump, awaiting test results.

OCA-git-bot · 2026-09-17T08:08:23Z

Congratulations, your PR was merged at 56d401a. Thanks a lot for contributing to OCA. ❤️

OCA-git-bot added series:18.0 mod:website_exclude_sitemap Module website_exclude_sitemap labels Apr 17, 2026

edescalona force-pushed the 18.0-add-website_exclude_sitemap branch from 6613e81 to 4fb3741 Compare April 20, 2026 15:29

edescalona marked this pull request as ready for review April 20, 2026 15:37

github-actions Bot added the stale PR/Issue without recent activity, it'll be soon closed automatically. label Aug 23, 2026

rrebollo reviewed Sep 2, 2026

View reviewed changes

github-actions Bot removed the stale PR/Issue without recent activity, it'll be soon closed automatically. label Sep 6, 2026

edescalona force-pushed the 18.0-add-website_exclude_sitemap branch 2 times, most recently from f6ca34c to 24c8346 Compare September 10, 2026 20:24

rrebollo approved these changes Sep 10, 2026

View reviewed changes

pedrobaeza added this to the 18.0 milestone Sep 11, 2026

edescalona force-pushed the 18.0-add-website_exclude_sitemap branch from 24c8346 to 249b83e Compare September 11, 2026 13:49

edescalona force-pushed the 18.0-add-website_exclude_sitemap branch from 249b83e to ad9964e Compare September 11, 2026 15:25

edescalona requested a review from rrebollo September 11, 2026 15:37

rrebollo approved these changes Sep 11, 2026

View reviewed changes

jelenapoblet approved these changes Sep 16, 2026

View reviewed changes

OCA-git-bot added the approved label Sep 16, 2026

OCA-git-bot added the ready to merge label Sep 16, 2026

OCA-git-bot added the bot is merging ⏳ label Sep 17, 2026

OCA-git-bot removed the bot is merging ⏳ label Sep 17, 2026

OCA-git-bot added the bot is merging ⏳ label Sep 17, 2026

OCA-git-bot merged commit cbe4716 into OCA:18.0 Sep 17, 2026
7 checks passed

OCA-git-bot added merged 🎉 and removed bot is merging ⏳ labels Sep 17, 2026

Uh oh!

Uh oh!

Conversation

edescalona commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

What it does

Pattern syntax

Implementation notes

Uh oh!

github-actions Bot commented Aug 23, 2026

Uh oh!

rrebollo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edescalona commented Sep 10, 2026

Uh oh!

rrebollo left a comment

Choose a reason for hiding this comment

Uh oh!

pedrobaeza commented Sep 11, 2026

Uh oh!

edescalona commented Sep 11, 2026

Uh oh!

pedrobaeza commented Sep 11, 2026

Uh oh!

edescalona commented Sep 11, 2026

Uh oh!

pedrobaeza commented Sep 11, 2026

Uh oh!

edescalona commented Sep 11, 2026

Uh oh!

pedrobaeza commented Sep 11, 2026

Uh oh!

rrebollo left a comment

Choose a reason for hiding this comment

Uh oh!

jelenapoblet left a comment

Choose a reason for hiding this comment

Uh oh!

edescalona commented Sep 16, 2026

Uh oh!

OCA-git-bot commented Sep 16, 2026

Uh oh!

pedrobaeza commented Sep 17, 2026

Uh oh!

OCA-git-bot commented Sep 17, 2026

Uh oh!

OCA-git-bot commented Sep 17, 2026

Uh oh!

pedrobaeza commented Sep 17, 2026

Uh oh!

sbidoul commented Sep 17, 2026

Uh oh!

pedrobaeza commented Sep 17, 2026

Uh oh!

OCA-git-bot commented Sep 17, 2026

Uh oh!

Uh oh!

OCA-git-bot commented Sep 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

edescalona commented Apr 17, 2026 •

edited

Loading