-
Notifications
You must be signed in to change notification settings - Fork 43
Improve Patcher documentation: clarify use cases and add simplified GitHub Actions guide #2723
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…itHub Actions guide - Add new 'GitHub Actions for Continuous Updates' guide for teams wanting to keep entire codebase current - Update promotion workflows guide to clarify it's for environment-specific promotion (dev → stage → prod) - Add clear distinction between two primary Patcher use cases: upgrading out-of-date code vs maintaining current code - Update sidebar navigation to include new guide as first option in Guides section - Add cross-references between the two approaches to help users choose the right workflow Co-Authored-By: Josh Padnick <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Join our Discord community for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
…ation - Fix typo 'leasat' -> 'least' in accountfactory drift remediation guide - Add comprehensive GitHub Enterprise fine-grained token setup section to Patcher continuous updates guide - Include step-by-step instructions for token creation with required permissions - Focus on organization's patcher-cli and terrapatch-cli repositories only Co-Authored-By: Josh Padnick <[email protected]>
Improve Patcher documentation: clarify use cases and add simplified GitHub Actions guide
Summary
This PR addresses the confusion around Patcher's two primary use cases by creating clearer documentation paths:
New guide: "GitHub Actions for Continuous Updates" - A simplified workflow that scans the entire repository and creates PRs for all outdated dependencies. Ideal for teams who want to keep their codebase current without environment-specific promotion.
Updated existing guide: Enhanced "Setting up Promotion Workflows" to clearly explain it's for teams needing dev → stage → prod promotion with environment-specific validation.
Key changes:
/docs/2.0/docs/patcher/guides/github-actions-continuous-updates.md
(171 lines) with a simplified GitHub Actions workflowThe new workflow removes the
include_dirs
filtering and environment-specific logic from the promotion workflow examples, making it suitable for scanning entire repositories.Review & Testing Checklist for Human
Notes
Link to Devin run: https://app.devin.ai/sessions/fc64367622e64e1d8f29fddec6441a64
Requested by: Josh Padnick (@josh-padnick)