Skip to content

Conversation

devin-ai-integration[bot]
Copy link

Add Patcher self-hosting documentation

Summary

This PR adds comprehensive documentation for self-hosting Patcher binaries to address DEV-1044. The changes include:

  • New self-hosting guide at docs/2.0/docs/patcher/guides/self-hosting.md (163 lines) explaining how customers can self-host Patcher and Terrapatch binaries rather than downloading directly from github.com/gruntwork-io
  • Updated installation documentation to include a link to the new self-hosting guide in the appropriate section
  • Updated sidebar navigation to include the new guide in the Patcher guides section

The documentation covers the requested structure: introduction to self-hosting, self-hosting options (repo-copier, forking, alternatives), GitHub Actions parameters and current limitations, code examples for GitHub Enterprise and GitLab CI, and unsupported methods.

Review & Testing Checklist for Human

  • Verify technical accuracy of patcher-action limitations: The documentation claims the action hardcodes GitHub organizations - confirm this is accurate by reviewing the patcher-action source code
  • Test internal documentation links: Verify the link to /2.0/docs/library/guides/self-hosting works correctly in the docs site
  • Check sidebar navigation: Ensure the new "Self-hosting Patcher" guide appears correctly in the Patcher guides section and the navigation works
  • Validate YAML syntax: Review the GitHub Actions workflow examples for correct syntax and best practices
  • Verify content completeness: Confirm all requested sections from DEV-1044 are covered (intro, self-hosting options, GitHub Actions parameters, code examples, unsupported methods)

Test Plan

  1. Build the docs site locally and navigate to the new self-hosting guide
  2. Verify all internal links work correctly
  3. Check that the sidebar navigation includes the new guide in the correct location
  4. Review the GitHub Actions YAML examples for syntax correctness

Notes

  • The documentation is based on analysis of the patcher-action source code (lines 184-197 in src/action.ts) which shows hardcoded GitHub organizations
  • GitLab CI support is mentioned as newer/experimental per the requirements, directing users to contact support
  • Artifactory is explicitly noted as unsupported per requirements
  • Link to Devin run: https://app.devin.ai/sessions/124b574c4e504fa485d99dc085e021b6
  • Requested by: Josh Padnick (@josh-padnick)

- Create comprehensive self-hosting guide at docs/2.0/docs/patcher/guides/self-hosting.md
- Document repo-copier as primary recommended approach for self-hosting binaries
- Explain current patcher-action limitations with hardcoded GitHub organizations
- Include GitHub Enterprise and GitLab CI configuration examples
- Add link to self-hosting guide in installation documentation
- Update sidebar navigation to include new self-hosting guide

Addresses DEV-1044

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 Ready Ready Preview Comment Aug 29, 2025 11:56pm

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.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

- Add gruntwork-io, minamijoyo, tfupdate, hcledit, self-hosting to custom-dictionary.txt
- These are legitimate technical terms used in the Patcher self-hosting documentation
- Resolves CircleCI validate_build spellcheck failure

Co-Authored-By: Josh Padnick <[email protected]>
This resolves the spellcheck error causing the validate_build CI failure.

Co-Authored-By: Josh Padnick <[email protected]>
- Add required repositories: patcher-cli, patcher-action, terrapatch-cli
- Include GitHub Actions permissions configuration instructions
- Specify access settings for organization and enterprise levels
- Provide actionable steps for users to configure repo-copier properly

Co-Authored-By: Josh Padnick <[email protected]>
@josh-padnick
Copy link
Contributor

Closing in favor of #2723

@josh-padnick
Copy link
Contributor

I made a mistake! This PR should stay open.

@josh-padnick josh-padnick reopened this Aug 30, 2025
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