fix: avoid rewriting existing IndexNow key files#11
Merged
Conversation
Make IndexNow key-file handling explicit and less invasive. When a configured IndexNow key is present, sitemap creation still ensures the matching verification file exists by default. If the file is already present and valid, Indexmap now leaves it unchanged instead of rewriting it. This keeps the simple public/ workflow intact while avoiding unnecessary filesystem churn. Add config.index_now.write_key_file so applications with custom serving or staging flows can opt out of automatic key-file writes entirely. The configured key remains available for IndexNow pinging even when file writing is disabled. This supports apps that generate sitemap XML in a temporary staging directory while serving the IndexNow verification file from a separate public path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make IndexNow key-file handling explicit and less invasive.
When a configured IndexNow key is present, sitemap creation still ensures the matching verification file exists by default. If the file is already present and valid, Indexmap now leaves it unchanged instead of rewriting it. This keeps the simple public/ workflow intact while avoiding unnecessary filesystem churn.
Add config.index_now.write_key_file so applications with custom serving or staging flows can opt out of automatic key-file writes entirely. The configured key remains available for IndexNow pinging even when file writing is disabled.
This supports apps that generate sitemap XML in a temporary staging directory while serving the IndexNow verification file from a separate public path.
How to test
Release notes
Does this change need an explicit changelog or release-note callout beyond the PR title?
Checklist
About the maintainers
Built by Ethos Link, the team behind Reviato.
Capture. Interpret. Act.
Turn guest feedback into clear next steps for your team. Collect private appraisals, spot patterns across reviews, and act before small issues turn into public ones.