Skip to content

Authors not returned for Github Enterprise #56

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

Open
jesusmah opened this issue Mar 20, 2024 · 3 comments
Open

Authors not returned for Github Enterprise #56

jesusmah opened this issue Mar 20, 2024 · 3 comments

Comments

@jesusmah
Copy link

jesusmah commented Mar 20, 2024

Im using the mkdocs-git-committers-plugin-2 version 2.3.0 and it does not seem to be able to properly return the authors for each page...

I can see the plugin working fine in the logs:

INFO    -  Building documentation...
INFO    -  git-committers plugin ENABLED
INFO    -  Cleaning site directory
INFO    -  git-committers: fetching contributors for docs/index.md
INFO    -  git-committers: fetching contributors for docs/contributing.md
INFO    -  git-committers: fetching contributors for docs/openshift/airgap-4-12.md
INFO    -  git-committers: fetching contributors for docs/openshift/devops-exercises-4-12.md
INFO    -  git-committers: fetching contributors for docs/openshift/ipi-4-14.md
INFO    -  git-committers: saving page authors cache file
INFO    -  Documentation built in 5.30 seconds

However, the cache folder in its page-authors.json contains empty authors list:

{"cache_date": "2024-03-20", "page_authors": {"docs/index.md": {"last_commit_date": "2023-10-23", "authors": []}, "docs/contributing.md": {"last_commit_date": "2023-10-23", "authors": []}, "docs/openshift/airgap-4-12.md": {"last_commit_date": "2023-11-09", "authors": []}, "docs/openshift/devops-exercises-4-12.md": {"last_commit_date": "2024-03-08", "authors": []}, "docs/openshift/ipi-4-14.md": {"last_commit_date": "2024-03-06", "authors": []}}}

The github token Im using if plenty of permissions.

@mike-19
Copy link

mike-19 commented Apr 1, 2024

suspect it could be due to the api_version not defined with the class however the validation in constructing the github URL looks for api_version

@jesusmah
Copy link
Author

jesusmah commented Apr 1, 2024

Hi Mike, thanks for your help. However, I did specify the API version:

- git-committers:
    enterprise_hostname: github.ibm.com
    api_version: v3
    repository: CSM-SPGI/training
    branch: main
    token: !ENV ["GH_TOKEN_MKDOCS"]

@sheeeng
Copy link

sheeeng commented Nov 18, 2024

#56 and #58 seems to be the same issue.

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

No branches or pull requests

3 participants