Skip to content
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

Merged
merged 5 commits into from
Apr 17, 2023

Conversation

jeffkala
Copy link
Contributor

@jeffkala jeffkala commented Apr 6, 2023

Closes: N/A

What's Changed

Be more explict that the currently functionalities within Git Repos don't support GitHub apps.

TODO

  • Explanation of Change(s)
  • Documentation Updates (when adding/changing features)

@jeffkala jeffkala changed the title Update gitrepository.md Doc Only: Update gitrepository.md about Github Apps Apr 6, 2023
@gsnider2195
Copy link
Contributor

By github apps do you mean something like https://github.com/marketplace/gitguardian

@jeffkala
Copy link
Contributor Author

jeffkala commented Apr 7, 2023

More like custom apps to try and solve not needing a service account.
https://docs.github.com/en/apps/creating-github-apps/creating-github-apps/about-apps

@gsnider2195
Copy link
Contributor

More like custom apps to try and solve not needing a service account. https://docs.github.com/en/apps/creating-github-apps/creating-github-apps/about-apps

I see. Maybe it would be clearer to just say something like nautobot only supports repositories that can be cloned with the git cli app using git clone?

@bryanculver
Copy link
Member

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 git clone onto the filesystem.

@bryanculver
Copy link
Member

Marking as WIP until feedback is addressed.

@bryanculver bryanculver marked this pull request as draft April 14, 2023 13:13
@bryanculver bryanculver changed the title Doc Only: Update gitrepository.md about Github Apps [WIP] Doc Only: Update gitrepository.md about Github Apps Apr 14, 2023
@jeffkala
Copy link
Contributor Author

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.

@jeffkala
Copy link
Contributor Author

More like custom apps to try and solve not needing a service account. https://docs.github.com/en/apps/creating-github-apps/creating-github-apps/about-apps

I see. Maybe it would be clearer to just say something like nautobot only supports repositories that can be cloned with the git cli app using git clone?

I'm open to changing the terminology but do think GH Apps should be directly called out.

Comment on lines 17 to 19
!!! 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
!!! 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`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

committed suggestion. Thanks!

@bryanculver bryanculver mentioned this pull request Apr 14, 2023
6 tasks
jeffkala and others added 3 commits April 17, 2023 07:42
@bryanculver bryanculver marked this pull request as ready for review April 17, 2023 18:39
@bryanculver bryanculver merged commit dfb9aaf into develop Apr 17, 2023
@bryanculver bryanculver deleted the jeffkala-docs-datasources-update branch April 17, 2023 18:39
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.

None yet

3 participants