-
Notifications
You must be signed in to change notification settings - Fork 263
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
[WIP] Doc Only: Update gitrepository.md about Github Apps #3548
Conversation
By github apps do you mean something like https://github.com/marketplace/gitguardian |
More like custom apps to try and solve not needing a service account. |
I see. Maybe it would be clearer to just say something like nautobot only supports repositories that can be cloned with the |
I'm confused here. Along with #3151, where is the use case where your Git Repository is a Github App? I can see the case for documentation stating we don't support Github App authentication but in review #3151 I'm not seeing how the REST API token can be used to perform a |
Marking as WIP until feedback is addressed. |
This is all about the management and accessibility to repositories. GH Apps provides some safeguards for this. Ultimately the goal of this PR is not to provide a fix or recommendation beyond just mentioning it in the docs that we don't support the functionality. I'm happy to add additional details if needed. |
I'm open to changing the terminology but do think GH Apps should be directly called out. |
!!! note | ||
GitHub Apps are not currently supported. GitHub Apps are not specifically focused on the workflow of creating/updating/deleting files. They can indeed perform these actions, but in order to accomplish that the client side MUST hit GitHub APIs instead of using standard command line or Python Git library tooling. At this time this functionality does not exist. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
!!! note | |
GitHub Apps are not currently supported. GitHub Apps are not specifically focused on the workflow of creating/updating/deleting files. They can indeed perform these actions, but in order to accomplish that the client side MUST hit GitHub APIs instead of using standard command line or Python Git library tooling. At this time this functionality does not exist. | |
!!! note | |
GitHub Apps are not currently supported. GitHub Apps are not specifically focused on the workflow of creating/updating/deleting files. Nautobot only supports repositories that can be cloned using standard git command line using `git clone`. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
committed suggestion. Thanks!
Co-authored-by: Bryan Culver <31187+bryanculver@users.noreply.github.com>
Closes: N/A
What's Changed
Be more explict that the currently functionalities within Git Repos don't support GitHub apps.
TODO