Skip to content

Commit

Permalink
Merge pull request #4303 from ojacques/master
Browse files Browse the repository at this point in the history
Updated git-committers to 1.1.0
  • Loading branch information
squidfunk authored Oct 1, 2022
2 parents 26b3070 + bc74a24 commit cec89f0
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down
5 changes: 0 additions & 5 deletions docs/schema/plugins/external/git-committers.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
16 changes: 5 additions & 11 deletions docs/setup/adding-a-git-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down

0 comments on commit cec89f0

Please sign in to comment.