Merge pull request #4303 from ojacques/master

Updated git-committers to 1.1.0
This commit is contained in:
Martin Donath 2022-10-01 17:01:54 +02:00 committed by GitHub
commit cec89f0c6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 17 deletions

View File

@ -58,7 +58,7 @@ jobs:
pip install .
pip install \
"cairosvg>=2.5" \
"mkdocs-git-committers-plugin-2<1" \
"mkdocs-git-committers-plugin-2>=1.1.1" \
"mkdocs-git-revision-date-localized-plugin>=1.0" \
"mkdocs-minify-plugin>=0.3" \
"mkdocs-rss-plugin>=1.1" \

View File

@ -26,11 +26,6 @@
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository",
"type": "string"
},
"token": {
"title": "Personal access token",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.token",
"type": "string"
}
},
"additionalProperties": false,
"required": [

View File

@ -250,7 +250,7 @@ Then, add the following lines to `mkdocs.yml`:
plugins:
- git-committers:
repository: squidfunk/mkdocs-material
token: !ENV GH_TOKEN
branch: main
```
The following configuration options are supported:
@ -267,21 +267,15 @@ The following configuration options are supported:
repository: squidfunk/mkdocs-material
```
[`token`](#+git-committers.token){ #+git-committers.token }
`branch`{ #committers-repository }
: :octicons-milestone-24: Default: _none_ This property should[^3] be set to
a [personal access token], which is used by the plugin to query GitHub's API
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.
: :octicons-milestone-24: Default: `master` This property should be set to
the branch of the repository from which to retrieve the contributors. To use the `main` branch:
``` yaml
plugins:
- git-committers:
token: !ENV GH_TOKEN
branch: main
```
The other configuration options of this extension are not officially supported