yozachar
commented
2 years ago Btw, I tested get_readme() works just fine I was able to retrieve your readme contents.
Please provide the workflow log, where it fails.
Closed ryanamay closed 2 years ago
yozachar
commented
2 years ago Btw, I tested get_readme() works just fine I was able to retrieve your readme contents.
Please provide the workflow log, where it fails.
ryanamay
commented
2 years ago Btw, I tested
get_readme()works just fine I was able to retrieve your readme contents. Please provide the workflow log, where it fails.
Hi! Thanks for the update, Here's the workflow log the first time:
[2022-07-04 02:31:51] ln. 367 DEBUG Initialize WakaReadme
[2022-07-04 02:31:51] ln. 371 DEBUG Input validation complete
[2022-07-04 02:31:51] ln. 323 DEBUG Conneting to GitHub
[2022-07-04 02:31:51] ln. 327 DEBUG Decoding readme contents
[2022-07-04 02:31:51] ln. 267 DEBUG Fetching WakaTime statistics
[2022-07-04 02:31:51] ln. 278 DEBUG API response @ trial #1: 200 OK
[2022-07-04 02:31:51] ln. 282 DEBUG Fetched WakaTime statistics
[2022-07-04 02:31:51] ln. 231 DEBUG Making contents
Other ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷ 99.17 %
[2022-07-04 02:31:51] ln. 191 DEBUG Generating graph for Other
[2022-07-04 02:31:51] ln. 200 DEBUG Other graph generated
[2022-07-04 02:31:51] ln. 255 DEBUG Contents were made
[2022-07-04 02:31:51] ln. 330 DEBUG Updating readme
[2022-07-04 02:31:52] ln. 376 CRITICAL 409 {"message": "README.md does not match ca46e1e4bb8f906131e42f54d756da9ead1398b3", "documentation_url": "https://docs.github.com/rest/reference/repos#create-or-update-file-contents"}Upon reading the documentation url, I assumed the issue is my readme isnt being properly read and then tried to fix it with the above changes, and it worked.
I'm guessing the symlink is being treated properly but waka-readme tries to edit the symlink rather than the actual readme.
yozachar
commented
2 years ago Sorry for the delay. Sending a GET request to the GitHub API's, provides same content for symbolic links and referenced files.
GET / HTTP/1.1
Host: api.github.com
User-Agent: Mozilla/5.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8
Accept-Language: en,en-US;q=0.7,en-GB;q=0.3
Accept-Encoding: gzip, deflate, br
Connection: keep-aliveWith PyGitHub..
from github import Github
g = Github('your_auth_token')
repo = g.get_repo('fuwaa/fuwaa')
readme_file = repo.get_readme()readme_file.path returns "README.md" instead of "profile-readme/README.md" which means it was requesting 2nd API URL. When it's fed back repo.update(readme_file.path, ...) causes it to fail as the file on the path is just a symlink.
I haven't found any attribute say... original_path for symbolic links, neither on PyGitHub nor on GitHub API. It'd be a good thing to raise upstream issue. Meanwhile this workaround seems okay, but the PR needs to be reworked. It would even better to start over. Closing this now.
Thanks for contributing!
PR Information
This PR adds the ability to use a custom readme location for those people that symlinks their readme file to another location such as myself (see screenshot).
Why?
The function
gh_repo.get_readme()only targets the symlink, resulting the workflow being unable to add wakatime statistics resulting in an error.Things I could've done
I could entirely omit the if statement and set the default variable for it to be
README.md, but I don't know if that will work for people with lowercasereadme.md's potentially breaking it and that's why I used an if statement.Checklist/Tests
Let me know if there's anything else :) also pardon my unverified commits, I have vigilant mode on and I forgot to change my
user.emailgit config.