Skip to content

[Artifacts] Fix example formatting and copy#32191

Open
dinasaur404 wants to merge 3 commits into
productionfrom
artifacts-build-and-deploy-on-push
Open

[Artifacts] Fix example formatting and copy#32191
dinasaur404 wants to merge 3 commits into
productionfrom
artifacts-build-and-deploy-on-push

Conversation

@dinasaur404

Copy link
Copy Markdown
Contributor

Summary

Fixes formatting and copy in the Artifacts build and deploy example page. Adds pipeline diagrams.

Documentation checklist

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

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

Pattern Owners
*.astro @cloudflare/content-engineering, @kodster28
/src/content/docs/artifacts/ @elithrar, @dmmulroy, @mattzcarey, @dinasaur404, @cloudflare/product-owners
*.ts @cloudflare/content-engineering, @kodster28

@dinasaur404
dinasaur404 force-pushed the artifacts-build-and-deploy-on-push branch from 3f44dc5 to d45b0f2 Compare July 20, 2026 22:58
@dinasaur404
dinasaur404 marked this pull request as ready for review July 20, 2026 23:02
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review

⚠️ 3 warnings, 💡 3 suggestions found in commit 3b78f59.

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

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.

---

## Code Review

### Warnings (1)

#### CR-307051b74a6d · Invalid trigger target field
- **File:** `src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx` line 95
- **Issue:** The note tells users to add `"dispatch_namespace": "<DISPATCH_NAMESPACE>"` to the Workflow trigger target, but no Wrangler trigger target schema in the repository documents a `dispatch_namespace` property. Dispatch namespaces are normally configured via the top-level `dispatch_namespaces` binding or `wrangler deploy --dispatch-namespace`.
- **Fix:** Verify that `dispatch_namespace` is a valid trigger target field for this event type; if not, remove the note or move the instruction to the deployment section using the `wrangler deploy --dispatch-namespace` flag.

---

## Conventions

### Warnings (1)

#### CV-1205a4904617 · Scope accuracy
- **File:** PR-level finding
- **Issue:** A new docs page was added at src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx, but the description only describes fixing formatting and copy in an existing page.
- **Fix:** Mention that the PR adds or re-creates the Artifacts build-and-deploy guide page.

---

## Style Guide Review

### Warnings (1)

#### SG-25d959b0ca78 · WranglerConfig compatibility_date should use \`$today\`
- **File:** `src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx` line 55
- **Issue:** Line adds `\t\"compatibility_date\": \"2026-07-21\",` inside `<WranglerConfig>`
- **Fix:** Use `\`$today\`` so the date is replaced at build time

### Suggestions (3)

#### SG-309cbe8c340b · Avoid `i.e.`
- **File:** `src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx` line 30
- **Issue:** Line adds `(i.e. \`pnpm-lock.yaml\`)`
- **Fix:** Replace `i.e.` with `that is` or restructure

#### SG-bcf7111bfa0b · Bullet list has fewer than three items
- **File:** `src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx` line 106
- **Issue:** The bulleted list starting at line 106 has only two items (Runners and Cache)
- **Fix:** Consider writing as prose instead

#### SG-eece61eaf50b · Avoid `i.e.`
- **File:** `src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx` line 182
- **Issue:** Line adds \`step, i.e. \`workspace.runner(...)\`
- **Fix:** Replace `i.e.` with `that is` or restructure

Code Review

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

Warnings (1)
File Issue
artifacts/guides/build-and-deploy-on-push.mdx line 95 Invalid trigger target field — The note tells users to add "dispatch_namespace": "<DISPATCH_NAMESPACE>" to the Workflow trigger target, but no Wrangler trigger target schema in the repository documents a dispatch_namespace property. Dispatch namespaces are normally configured via the top-level dispatch_namespaces binding or wrangler deploy --dispatch-namespace. Fix: Verify that dispatch_namespace is a valid trigger target field for this event type; if not, remove the note or move the instruction to the deployment section using the wrangler deploy --dispatch-namespace flag.

Conventions

Warnings (1)
File Issue
PR Scope accuracy — A new docs page was added at src/content/docs/artifacts/guides/build-and-deploy-on-push.mdx, but the description only describes fixing formatting and copy in an existing page. Fix: Mention that the PR adds or re-creates the Artifacts build-and-deploy guide page.

Style Guide Review

Warnings (1)
File Issue
artifacts/guides/build-and-deploy-on-push.mdx line 55 WranglerConfig compatibility_date should use `$today` — Line adds \t\"compatibility_date\": \"2026-07-21\", inside <WranglerConfig> Fix: Use \$today`` so the date is replaced at build time
Suggestions (3)
File Issue
artifacts/guides/build-and-deploy-on-push.mdx line 30 Avoid i.e. — Line adds (i.e. \pnpm-lock.yaml`)Fix: Replacei.e.withthat is` or restructure
artifacts/guides/build-and-deploy-on-push.mdx line 106 Bullet list has fewer than three items — The bulleted list starting at line 106 has only two items (Runners and Cache) Fix: Consider writing as prose instead
artifacts/guides/build-and-deploy-on-push.mdx line 182 Avoid i.e. — Line adds `step, i.e. `workspace.runner(...)` Fix: Replace i.e. with that is or restructure
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.

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

@mia303
mia303 force-pushed the artifacts-build-and-deploy-on-push branch from c48b4eb to 3b78f59 Compare July 22, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants