docs: Specify HTTPS requirement - #917
Merged
Merged
Conversation
…installation access tokens Signed-off-by: Stephen Simpson <ssimpson89@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The change is a targeted documentation clarification consistent with the described intent and does not introduce any apparent technical or formatting issues.
Pull request overview
This PR updates the credential plugin documentation to explicitly require using an HTTPS Source Control URL when authenticating project syncs with GitHub App Installation Access Tokens, clarifying that SSH-based clones are not supported by this lookup.
Changes:
- Documented that GitHub App installation access tokens require cloning over HTTPS and provided an HTTPS URL example.
- Clarified that SSH clones continue to require an SCM Private Key and an SSH-form repository URL.
File summaries
| File | Description |
|---|---|
| docs/docsite/rst/userguide/credential_plugins.rst | Adds an explicit HTTPS requirement and clarifies SSH behavior for GitHub App installation token usage in project syncs. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
cigamit
approved these changes
Sep 11, 2026
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
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.
SUMMARY
Quick note to specify the HTTPS url and not the HTTP
ISSUE TYPE
COMPONENT NAME