Skip to content

[Rules] Document pre-deployment validation - #33523

Open
mbullock1986 wants to merge 2 commits into
cloudflare:productionfrom
mbullock1986:changelog-rulesets-dry-run
Open

mbullock1986 wants to merge 2 commits into
cloudflare:productionfrom
mbullock1986:changelog-rulesets-dry-run

Conversation

@mbullock1986

Copy link
Copy Markdown
Collaborator

Summary

  • Document automatic Rules dashboard validation before deployment.
  • Document Rulesets API validation with the dry_run=true query parameter.
  • Add a Rules changelog entry with an API example.

Related: SHIP-11749

Documentation checklist

  • Is there a changelog entry (guidelines)?
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page - an issue has been opened in relation to any incorrect or out of date information that this PR fixes.

@mbullock1986
mbullock1986 requested review from a team and smarsh-cf as code owners September 18, 2026 12:38
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Review

💡 3 suggestions found in commit d268097.

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

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, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.

The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.

---

## Style Guide Review

### Suggestions (3)

#### SG-cf92f167a65f · Use <APIRequest> instead of <CURL> for Cloudflare API endpoints
- **File:** `src/content/docs/ruleset-engine/rulesets-api/dry-run.mdx` line 48
- **Issue:** Added <CURL> props document a Cloudflare API endpoint (https://api.cloudflare.com/client/v4/zones/...) with headers, query, and json
- **Fix:** Use the <APIRequest> component instead of <CURL> when documenting a Cloudflare API endpoint

#### SG-f9f191f02421 · Semicolons joining independent clauses
- **File:** `src/content/changelog/rules/2026-09-17-rulesets-dry-run-validation.mdx` line 11
- **Issue:** Line 11 uses a semicolon to join two independent clauses: `... return \`result: null\`; operations that normally return \`204\` continue to do so.`
- **Fix:** Break into two sentences, e.g. `Successful operations that normally return a \`200\` response return \`result: null\`. Operations that normally return \`204\` continue to do so.`

#### SG-359e6a8a55dc · Avoid semicolons joining independent clauses
- **File:** `src/content/changelog/rules/2026-09-17-rulesets-dry-run-validation.mdx` line 11
- **Issue:** `...return `result: null`; operations that normally return `204` continue to do so.` joins two independent clauses with a semicolon.
- **Fix:** Break into two sentences: `...return `result: null`. Operations that normally return `204` continue to do so.`

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 (3)
File Issue
ruleset-engine/rulesets-api/dry-run.mdx line 48 Use instead of for Cloudflare API endpoints — Added props document a Cloudflare API endpoint (https://api.cloudflare.com/client/v4/zones/...) with headers, query, and json Fix: Use the component instead of when documenting a Cloudflare API endpoint
changelog/rules/2026-09-17-rulesets-dry-run-validation.mdx line 11 Semicolons joining independent clauses — Line 11 uses a semicolon to join two independent clauses: ... return \result: null`; operations that normally return `204` continue to do so.Fix: Break into two sentences, e.g.Successful operations that normally return a `200` response return `result: null`. Operations that normally return `204` continue to do so.`
changelog/rules/2026-09-17-rulesets-dry-run-validation.mdx line 11 Avoid semicolons joining independent clauses...return result: null; operations that normally return 204 continue to do so. joins two independent clauses with a semicolon. Fix: Break into two sentences: ...return result: null. Operations that normally return 204 continue to do so.
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. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

@cloudflare-docs-bot

Copy link
Copy Markdown
Contributor

Review coverage

🟡 2 ownership areas need approval.

Needs approval Eligible approvers Suggested
rules @maurizioabba, @mbullock1986, @smarsh-cf, @cloudflare/appsec-reviewers, @cloudflare/pm-changelogs, @cloudflare/product-owners ahaywood, asamborski, asomaiah-cf, baubuchon-cf, Brayden, celso, colbywhite, danielegm, deannalam, dinasaur404, diogoascarneiro, ethulia, grstnhbr, hoan-pom, irvinebroque, jhutchings1, jonesphillip, jroyal, kathayl, kennyj42, korinne, Marcinthecloud, MattieTK, maurizioabba, mbullock1986, mchenco, mia303, MohamedH1998, mvvmm, nevikashah, nikitacano, renandincer, rianvdm, rita3ko, scottbuscemi, sejoker, sgoldsmith-cf, smarsh-cf, steve-cloudflare, stritt, thomasgauvin, TownLake, tsmith512, vy-ton, WalshyDev, yomna-shousha
CODEOWNERS fallback · not notified
ruleset-engine @maurizioabba, @mbullock1986, @cloudflare/appsec-reviewers, @cloudflare/product-owners ahaywood, asamborski, baubuchon-cf, Brayden, celso, colbywhite, danielegm, deannalam, dinasaur404, diogoascarneiro, grstnhbr, hoan-pom, irvinebroque, jhutchings1, jroyal, kathayl, kennyj42, korinne, Marcinthecloud, maurizioabba, mbullock1986, mchenco, MohamedH1998, mvvmm, nevikashah, nikitacano, renandincer, rianvdm, sejoker, sgoldsmith-cf, steve-cloudflare, TownLake, tsmith512, WalshyDev, yomna-shousha
CODEOWNERS fallback · not notified
CODEOWNERS mappings for displayed areas (2)
Pattern Owners
/src/content/changelog/rules/ @maurizioabba, @mbullock1986, @smarsh-cf, @cloudflare/appsec-reviewers, @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/ruleset-engine/ @maurizioabba, @mbullock1986, @cloudflare/appsec-reviewers, @cloudflare/product-owners

DavidJKTofan added a commit to DavidJKTofan/davidtofan that referenced this pull request Sep 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant