Skip to content

Commit cec89f0

Browse files
authored
Merge pull request #4303 from ojacques/master
Updated git-committers to 1.1.0
2 parents 26b3070 + bc74a24 commit cec89f0

File tree

3 files changed

+6
-17
lines changed

3 files changed

+6
-17
lines changed

.github/workflows/documentation.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
pip install .
5959
pip install \
6060
"cairosvg>=2.5" \
61-
"mkdocs-git-committers-plugin-2<1" \
61+
"mkdocs-git-committers-plugin-2>=1.1.1" \
6262
"mkdocs-git-revision-date-localized-plugin>=1.0" \
6363
"mkdocs-minify-plugin>=0.3" \
6464
"mkdocs-rss-plugin>=1.1" \

docs/schema/plugins/external/git-committers.json

-5
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,6 @@
2626
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository",
2727
"type": "string"
2828
},
29-
"token": {
30-
"title": "Personal access token",
31-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.token",
32-
"type": "string"
33-
}
3429
},
3530
"additionalProperties": false,
3631
"required": [

docs/setup/adding-a-git-repository.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Then, add the following lines to `mkdocs.yml`:
250250
plugins:
251251
- git-committers:
252252
repository: squidfunk/mkdocs-material
253-
token: !ENV GH_TOKEN
253+
branch: main
254254
```
255255

256256
The following configuration options are supported:
@@ -267,21 +267,15 @@ The following configuration options are supported:
267267
repository: squidfunk/mkdocs-material
268268
```
269269

270-
[`token`](#+git-committers.token){ #+git-committers.token }
270+
`branch`{ #committers-repository }
271271

272-
: :octicons-milestone-24: Default: _none_ – This property should[^3] be set to
273-
a [personal access token], which is used by the plugin to query GitHub's API
274-
for document contributor information:
275-
276-
[^3]:
277-
Setting a [personal access token] is not required, but recommended, as
278-
GitHub has very low [rate limits] on their APIs that you'll probably run
279-
into. When using a token, [rate limits] are much higher.
272+
: :octicons-milestone-24: Default: `master` – This property should be set to
273+
the branch of the repository from which to retrieve the contributors. To use the `main` branch:
280274

281275
``` yaml
282276
plugins:
283277
- git-committers:
284-
token: !ENV GH_TOKEN
278+
branch: main
285279
```
286280

287281
The other configuration options of this extension are not officially supported

0 commit comments

Comments
 (0)