Skip to content

Automatically add _ftindex:<yes/no> tag at creator start based on indexing configuration#305

Merged
benoit74 merged 1 commit into
mainfrom
ftindex_auto
May 28, 2026
Merged

Automatically add _ftindex:<yes/no> tag at creator start based on indexing configuration#305
benoit74 merged 1 commit into
mainfrom
ftindex_auto

Conversation

@benoit74
Copy link
Copy Markdown
Collaborator

Fix #295

Remark: IMHO this needs to be merged in a major release because it changes the behavior of Creator.add_metadata method (it is not possible to set "Tags" metadata once scraper has started). Am I too finicky?

@benoit74 benoit74 self-assigned this May 28, 2026
@benoit74 benoit74 force-pushed the ftindex_auto branch 2 times, most recently from 502bbd9 to 201e0b2 Compare May 28, 2026 08:55
@benoit74 benoit74 requested a review from rgaudin May 28, 2026 08:58
@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (e0f7b72) to head (cef6a81).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #305   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           41        41           
  Lines         2545      2555   +10     
  Branches       363       365    +2     
=========================================
+ Hits          2545      2555   +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Member

@rgaudin rgaudin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread src/zimscraperlib/zim/creator.py
Comment thread src/zimscraperlib/zim/creator.py
@rgaudin
Copy link
Copy Markdown
Member

rgaudin commented May 28, 2026

Remark: IMHO this needs to be merged in a major release because it changes the behavior of Creator.add_metadata method (it is not possible to set "Tags" metadata once scraper has started). Am I too finicky?

Well it could be argued that the API hasn't changed and it's just fixing the behavior… but it lasted so long that it is now seen as a change.

I have no opinion

@benoit74
Copy link
Copy Markdown
Collaborator Author

Let's merge as-is, we can always refine in the aftermath if needed.

This is indeed not an API change, and not a "usual" behavior (at least not recommended anymore since 5.0). So I propose to keep this in this release, I will just amend the CHANGELOG to emphasis this is a behavior change rather than a breaking one.

@benoit74 benoit74 merged commit 1d16f49 into main May 28, 2026
3 checks passed
@benoit74 benoit74 deleted the ftindex_auto branch May 28, 2026 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automatically set _ftindex tag based on config_indexing

2 participants