Skip to content

docs(cache): Clarify custom cache key behavior with single-file purge#32135

Open
mbullock1986 wants to merge 1 commit into
productionfrom
cache-rules-custom-key-purge-docs
Open

docs(cache): Clarify custom cache key behavior with single-file purge#32135
mbullock1986 wants to merge 1 commit into
productionfrom
cache-rules-custom-key-purge-docs

Conversation

@mbullock1986

Copy link
Copy Markdown
Collaborator

Cache Rules that set custom cache keys require API purge with headers/cookies rather than dashboard single-file purge. This clarification reduces customer escalations about why single-file purge does not invalidate cached resources.

Also updates the purge compatibility note in Cache Rules settings to reference the detailed limitations page.

Changes

  • cache/how-to/cache-rules/index.mdx: Added Cache Rules and cache keys section
  • cache/how-to/purge-cache/purge-by-single-file.mdx: Added Limitations and alternatives
  • cache/how-to/cache-rules/settings.mdx: Updated purge compatibility note
  • changelog/rules/2026-07-16-cache-rules-bot-fields-asn.mdx: Changelog entry for bot fields

@mbullock1986
mbullock1986 requested review from a team, ack-cf and zaidoon1 as code owners July 17, 2026 13:34
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review

💡 1 suggestion found in commit da8cce7.

Fix in your agent
Fix the following review findings in PR #32135 (https://github.com/cloudflare/cloudflare-docs/pull/32135).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, fix all legitimate findings. For any you decide to skip,
post a comment on this PR with the finding ID and your reasoning.

---

## Style Guide Review

### Suggestions (1)

#### SG-b7daeb8099bd · Oxford comma
- **File:** `src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx` line 36
- **Issue:** List of three or more items lacks a comma before the conjunction: "headers, cookies, or other request properties"
- **Fix:** Add a serial comma: "headers, cookies, or other request properties" → "headers, cookies, or other request properties"

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

Suggestions (1)
File Issue
cache/how-to/purge-cache/purge-by-single-file.mdx line 36 Oxford comma — List of three or more items lacks a comma before the conjunction: "headers, cookies, or other request properties" Fix: Add a serial comma: "headers, cookies, or other request properties" → "headers, cookies, or other request properties"
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. Stops if there are conflicts and reports which files conflict.
/rebaseWithConflicts Rebases against production and attempts to resolve conflicts automatically using AI. Stops with an explanation if confidence is not high enough.

@github-actions github-actions Bot added product:cache Issues or PRs related to Cache size/s labels Jul 17, 2026
@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/cache/ @cloudflare/product-owners, @ack-cf, @zaidoon1

@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Comment thread src/content/docs/cache/how-to/cache-rules/index.mdx Outdated
Comment thread src/content/docs/cache/how-to/cache-rules/index.mdx
Comment thread src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx
@mbullock1986
mbullock1986 force-pushed the cache-rules-custom-key-purge-docs branch from 50172da to fd8998b Compare July 20, 2026 12:23
@mbullock1986
mbullock1986 requested a review from a team as a code owner July 20, 2026 12:23
@mbullock1986
mbullock1986 force-pushed the cache-rules-custom-key-purge-docs branch 3 times, most recently from 19d96fb to 4970e6c Compare July 20, 2026 13:06
@mbullock1986

Copy link
Copy Markdown
Collaborator Author

Skipped: SG-23d12b43f00e — The passive voice finding on line 25 of purge-by-single-file.mdx refers to existing text that was already present before this PR (the 'How to purge a single file' section). Since this is pre-existing content and not part of the changes introduced here, I'm skipping it to avoid scope creep. Happy to address it in a follow-up if needed.

@mbullock1986
mbullock1986 force-pushed the cache-rules-custom-key-purge-docs branch from 4970e6c to fa6d5c3 Compare July 20, 2026 13:12
@mbullock1986

Copy link
Copy Markdown
Collaborator Author

Skipped: CR-27c2fe46e171 — Already fixed in the previous round of review. The current file shows (no leading dot).

Skipped: SG-34e3db81e722 — Already fixed in the previous round. The 'What to do instead' section under 'Cache Rules that match on request properties' was rewritten as prose paragraphs (lines 51-53), not a bullet list.

Skipped: SG-69291c84f3d9 — Already fixed in the previous round. The note in settings.mdx was rewritten as a single prose sentence (line 40), not a bullet list.

@mbullock1986

Copy link
Copy Markdown
Collaborator Author

Skipped: CR-27c2fe46e171 — Already fixed in the previous round of review. The current file shows cf.bot_management.bot_tags["<TAG>"] (no leading dot).

Skipped: SG-34e3db81e722 — Already fixed in the previous round. The "What to do instead" section under "Cache Rules that match on request properties" was rewritten as prose paragraphs (lines 51-53), not a bullet list.

Skipped: SG-69291c84f3d9 — Already fixed in the previous round. The note in settings.mdx was rewritten as a single prose sentence (line 40), not a bullet list.

Cache Rules that set custom cache keys require API purge with headers/cookies
rather than dashboard single-file purge. This clarification reduces customer
escalations about why single-file purge does not invalidate cached resources.
@mbullock1986
mbullock1986 force-pushed the cache-rules-custom-key-purge-docs branch from fa6d5c3 to da8cce7 Compare July 20, 2026 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:cache Issues or PRs related to Cache size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants