Skip to content

Commit ab15c14

Browse files
committed
Add precisions on token
1 parent 0f31eb6 commit ab15c14

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,18 @@ unless you access private repositories.
6060
- `gitlab_repository` - For GitLab, the project ID, e.g. '12345678'
6161
- `branch` - The name of the branch to get contributors from. Example: 'master'
6262
(default)
63-
- `token` - A GitHub or GitLab personal access token for REST API calls. The
64-
token does not need any scope: uncheck everything when creating the GitHub
65-
Token at
66-
[github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new),
67-
unless you access private repositories. For GitLab, create a token at
68-
[gitlab.com/-/profile/personal_access_tokens](https://gitlab.com/-/profile/personal_access_tokens).
63+
- `token` - A GitHub or GitLab personal access token for REST API calls.
64+
- For GitHub, token does not need any scope: uncheck everything when creating
65+
the GitHub Token at
66+
[github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new),
67+
unless you access private repositories.
68+
- For GitLab, a
69+
[project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html)
70+
scoped to `read_api` is expected to work. That way, the token is limited to
71+
the project and has access to read the repository. You could use a personal
72+
access token at
73+
[gitlab.com/-/profile/personal_access_tokens](https://gitlab.com/-/profile/personal_access_tokens),
74+
but it will grant access to more repositories than you want.
6975
- `enterprise_hostname` - For GitHub enterprise: the GitHub enterprise hostname.
7076
- `gitlab_hostname` - For GitLab: the GitLab hostname if different from
7177
gitlab.com (self-hosted).
@@ -114,6 +120,7 @@ Note: the plugin configuration in `mkdocs.yml` still uses the original `git-comm
114120
115121
- Getting the contributors relies on what is available on GitHub or GitLab.
116122
- For now, Git submodule is not supported and will report no contributors.
123+
- GitLab users may not be properly identified. See [issue #50](https://github.com/ojacques/mkdocs-git-committers-plugin-2/issues/50)
117124
118125
## Usage
119126

0 commit comments

Comments
 (0)