feat: Add github client for commit and versioning #8
Conversation
This file contains 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
jczhong84
reviewed
Oct 25, 2024
| Initialize the GitHub client with an access token from the session. | ||
| Raises an exception if the token is not found. | ||
| """ | ||
| access_token = self._get_access_token() |
There was a problem hiding this comment.
instead of getting the access token inside this class, how about passing it token as parameter so that this class can be decoupled from the flask_session?
| self.user = self.client.get_user() | ||
| self.github_link = github_link | ||
| self.repo = self._get_repository() | ||
| self.branch = "main" |
There was a problem hiding this comment.
It seems that the branch name needs to be configurable.
| if not repo_url: | ||
| LOG.error("GITHUB_REPO_URL is not configured") | ||
| raise Exception("GITHUB_REPO_URL is not configured") | ||
| repo_full_name = self._extract_repo_full_name(repo_url) |
There was a problem hiding this comment.
if repo_url is only used to parse the repo full name, why not just provide the repo name in the config directly?
| file_name = f"datadoc_{datadoc.id}.md" | ||
| return f"{directory}/{file_name}" | ||
|
|
||
| def commit_datadoc(self, datadoc: DataDoc, commit_message: Optional[str] = None): |
Comment on lines
72
to
74
| commit_message = ( | ||
| f"Update DataDoc {datadoc.id}: {datadoc.title or 'Untitled'}" | ||
| ) |
There was a problem hiding this comment.
do we want to allow user to provide a custom commit message?
| ) | ||
| LOG.info(f"Updated file {self.file_path} in repository.") | ||
| except GithubException as e: | ||
| if e.status == 404: |
There was a problem hiding this comment.
if this the recommended way to check the file existence?
zhangvi7
force-pushed
the
github/client
branch
from
d75e2ca
to
e7f1935
Compare
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.
Context
Changes
Test Plan