Skip to content

update docs to reflect latest patcher action#3007

Open
odgrim wants to merge 1 commit intomainfrom
patcher-action-docs
Open

update docs to reflect latest patcher action#3007
odgrim wants to merge 1 commit intomainfrom
patcher-action-docs

Conversation

@odgrim
Copy link
Copy Markdown
Contributor

@odgrim odgrim commented Feb 25, 2026

Summary by CodeRabbit

  • Documentation
    • Updated promotion workflows guide with clearer setup instructions for event-driven automation.
    • Added detailed examples and YAML configuration snippets for GitHub Actions integration.
    • Improved prerequisites section with guidance on authentication methods and environment organization.
    • Simplified workflow patterns for consistent environment pipeline management.
    • Clarified how merged changes automatically trigger downstream environment workflows.

@vercel
Copy link
Copy Markdown

vercel bot commented Feb 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Building Building Preview, Comment Feb 25, 2026 1:58am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 25, 2026

Walkthrough

Documentation for promotion workflows is rewritten to describe an automated, event-driven flow using GitHub Actions v5. Merges trigger subsequent environment workflows automatically, introducing OIDC/Secrets authentication, label-based triggering, and consolidated per-environment configuration patterns.

Changes

Cohort / File(s) Summary
Promotion Workflows Documentation
docs/2.0/docs/patcher/guides/promotion-workflows.md
Complete rewrite describing event-driven promotion flow: merge triggers next environment's workflow instead of manual downstream PR creation. Updates prerequisites to emphasize patcher-action@v5, introduces OIDC/Secrets and fallback token approaches, reworks environment organization with explicit include_dirs patterns and label-based triggering. Consolidates per-environment workflows to a consistent patcher-action pattern with updated YAML scaffolding examples.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

Workflows now flow with purpose true, 🚀
Events cascade through stages new,
Labels guide the automated way,
Merges beget tomorrow's play! ✨
No more waiting, no more delay—
Promotion dances, GitHub's ballet.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating documentation to reflect the latest patcher action version and workflow improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch patcher-action-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/2.0/docs/patcher/guides/promotion-workflows.md`:
- Line 197: The conditional for the patcher job contains an unreachable branch
"github.event_name == 'schedule'"; edit the patcher job's if expression (the
line with "if: github.event_name == 'repository_dispatch' || github.event_name
== 'schedule' || github.event_name == 'workflow_dispatch'") to remove the
"github.event_name == 'schedule'" clause so it matches the workflow's actual on:
triggers and avoid misleading documentation.

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc9c1fc and 4c77deb.

📒 Files selected for processing (1)
  • docs/2.0/docs/patcher/guides/promotion-workflows.md


patcher-report:
patcher:
if: github.event_name == 'repository_dispatch' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove unreachable schedule branch from stage patcher job condition.

Line 197 includes github.event_name == 'schedule', but this workflow’s on: block (Lines 170–178) does not define a schedule trigger. This is a copy/paste mismatch and can mislead readers.

Proposed doc fix
-    if: github.event_name == 'repository_dispatch' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    if: github.event_name == 'repository_dispatch' || github.event_name == 'workflow_dispatch'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if: github.event_name == 'repository_dispatch' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
if: github.event_name == 'repository_dispatch' || github.event_name == 'workflow_dispatch'
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/2.0/docs/patcher/guides/promotion-workflows.md` at line 197, The
conditional for the patcher job contains an unreachable branch
"github.event_name == 'schedule'"; edit the patcher job's if expression (the
line with "if: github.event_name == 'repository_dispatch' || github.event_name
== 'schedule' || github.event_name == 'workflow_dispatch'") to remove the
"github.event_name == 'schedule'" clause so it matches the workflow's actual on:
triggers and avoid misleading documentation.

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.

1 participant