Add self-hosted Patcher binaries documentation (DEV-1044) #2721
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
- Create comprehensive guide for using Patcher with self-hosted binaries - Document new parameters from feat-custom-org branch for custom SCM providers - Include GitHub Enterprise and GitLab configuration examples - Reference repo-copier usage and existing Library documentation - Add troubleshooting section and Artifactory limitations - Addresses DEV-1044 requirements for enterprise customers with network restrictions 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:
|
|
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 (
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Remove reference to non-existent troubleshooting guide - Replace with general reference to Patcher documentation - Resolves validate_build and Vercel deployment CI failures Co-Authored-By: Josh Padnick <[email protected]>
- Use second person throughout following Boise State writing guidelines - Reorganize to present two main self-hosting options clearly - Remove GitLab examples, replace with support email instruction - Remove repo-copier code examples and version management section - Update section headers (New self-hosted parameters → GitHub Actions parameters) - Move Artifactory limitations to bottom of document - Improve overall document flow and user-focused language Co-Authored-By: Josh Padnick <[email protected]>
- Add back repo-copier code examples showing how to copy patcher-cli and terrapatch-cli - Clarify that Patcher scans code/updates files, Terrapatch does transformations - Explain that all Patcher customers have access to github.com/gruntwork-io/patcher-cli - Update GitLab section to reflect that support is new, direct to support email - Emphasize that only binaries need self-hosting, not the service itself - Change 'Example configuration' to 'Example configurations' for consistency Co-Authored-By: Josh Padnick <[email protected]>
|
Closing in favor of #2722. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add self-hosted Patcher binaries documentation (DEV-1044)
Summary
This PR adds comprehensive documentation at
docs/2.0/docs/patcher/installation/self-hosted.mdexplaining how to use Patcher with self-hosted binaries for enterprise customers with network restrictions or security policies requiring internal hosting of dependencies.The documentation covers a two-step process: using repo-copier to copy Patcher/Terrapatch binaries to internal repositories, then configuring the GitHub Action with new parameters from the feat-custom-org branch (
scm_type,scm_base_url,scm_org,patcher_git_repo,terrapatch_git_repo,terrapatch_scm_org).Includes practical YAML examples for GitHub Enterprise, GitLab, troubleshooting guidance, and explains why Artifactory is not currently supported.
Review & Testing Checklist for Human
scm_type,scm_base_url, etc.) were sourced from the feat-custom-org branch and need validation against the final implementation/2.0/docs/library/guides/self-hosting,/2.0/docs/patcher/guides/troubleshootingand other internal docs resolve correctlyTest Plan Recommendation
Notes