Skip to content

Conversation

devin-ai-integration[bot]
Copy link

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:

  1. 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.

  2. 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:

  • Created /docs/2.0/docs/patcher/guides/github-actions-continuous-updates.md (171 lines) with a simplified GitHub Actions workflow
  • Updated promotion workflows guide to clarify when to use each approach
  • Added the new guide to sidebar navigation as the first option in Guides section
  • Added cross-references between the two guides to help users choose the right approach

The 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

  • Verify docs site builds and renders correctly - Test that the new markdown file renders properly and doesn't break the documentation site
  • Validate GitHub Actions YAML syntax - Check that the workflow in the new guide has correct YAML syntax and valid patcher-action parameters
  • Test all internal links - Confirm cross-references between the new continuous updates guide and promotion workflows guide work correctly
  • Review user experience flow - Ensure the distinction between the two approaches is clear and users can easily choose the right path
  • Check sidebar navigation - Verify the new guide appears correctly in the sidebar and doesn't break navigation

Notes

  • The new workflow is based on the existing promotion workflow examples but simplified to remove environment-specific scanning
  • Cross-references were added in both directions to help users navigate between the two approaches
  • The new guide was positioned first in the Guides section since it's the simpler use case

Link to Devin run: https://app.devin.ai/sessions/fc64367622e64e1d8f29fddec6441a64
Requested by: Josh Padnick (@josh-padnick)

…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]>
Copy link
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link

vercel bot commented Aug 29, 2025

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

Project Deployment Preview Comments Updated (UTC)
docs Error Error Sep 10, 2025 5:15pm

Copy link
Contributor

coderabbitai bot commented Aug 29, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

…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]>
devin-ai-integration bot and others added 2 commits September 2, 2025 16:52
- Document key breaking changes: token consolidation, parameter renames
- Add before/after workflow examples for easy migration
- Include custom organization setup instructions for v3
- Update existing workflow examples to use v3 syntax
- Provide migration checklist for systematic upgrade process

Co-Authored-By: Josh Padnick <[email protected]>
…tom-org inputs/outputs and workflow setup

Co-Authored-By: Josh Padnick <[email protected]>
Copy link
Author

Devin is archived and cannot be woken up. Please unarchive Devin if you want to continue using it.

2 similar comments
Copy link
Author

Devin is archived and cannot be woken up. Please unarchive Devin if you want to continue using it.

Copy link
Author

Devin is archived and cannot be woken up. Please unarchive Devin if you want to continue using it.

…ub Action ongoing updates

Co-Authored-By: Josh Padnick <[email protected]>
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.

2 participants