Updated git-committers to 1.0.0

This commit is contained in:
Olivier Jacques 2022-08-31 22:57:27 +02:00
parent 3d8e82ccf7
commit a551e2c483
3 changed files with 6 additions and 17 deletions

View File

@ -57,7 +57,7 @@ jobs:
run: | run: |
pip install . pip install .
pip install \ pip install \
"mkdocs-git-committers-plugin-2>=0.4.3" \ "mkdocs-git-committers-plugin-2>=1.0.0" \
"mkdocs-git-revision-date-localized-plugin>=1.0" \ "mkdocs-git-revision-date-localized-plugin>=1.0" \
"mkdocs-minify-plugin>=0.3" \ "mkdocs-minify-plugin>=0.3" \
"mkdocs-redirects>=1.0" "mkdocs-redirects>=1.0"

View File

@ -26,11 +26,6 @@
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config", "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
"type": "string" "type": "string"
}, },
"token": {
"title": "Personal access token",
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
"type": "string"
}
}, },
"additionalProperties": false, "additionalProperties": false,
"required": [ "required": [

View File

@ -233,7 +233,7 @@ Then, add the following lines to `mkdocs.yml`:
plugins: plugins:
- git-committers: - git-committers:
repository: squidfunk/mkdocs-material repository: squidfunk/mkdocs-material
token: !ENV GH_TOKEN branch: main
``` ```
The following configuration options are supported: The following configuration options are supported:
@ -250,21 +250,15 @@ The following configuration options are supported:
repository: squidfunk/mkdocs-material repository: squidfunk/mkdocs-material
``` ```
`token`{ #committers-repository } `branch`{ #committers-repository }
: :octicons-milestone-24: Default: _none_ This property should[^3] be set to : :octicons-milestone-24: Default: `master` This property should be set to
a [personal access token], which is used by the plugin to query GitHub's API the branch of the repository from which to retrieve the contributors. To use the `main` branch:
for document contributor information:
[^3]:
Setting a [personal access token] is not required, but recommended, as
GitHub has very low [rate limits] on their APIs that you'll probably run
into. When using a token, [rate limits] are much higher.
``` yaml ``` yaml
plugins: plugins:
- git-committers: - git-committers:
token: !ENV GH_TOKEN branch: main
``` ```
The other configuration options of this extension are not officially supported The other configuration options of this extension are not officially supported