Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated git-committers to 1.1.0 #4303

Merged
merged 6 commits into from
Oct 1, 2022
Merged

Updated git-committers to 1.1.0 #4303

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a551e2c
Updated git-committers to 1.0.0
ojacques Aug 31, 2022
502fc95
Merge branch 'master' into master
ojacques Sep 1, 2022
023af66
Bumping to 1.0.2
ojacques Sep 4, 2022
52ff9da
Bump to 1.1.0 to benefit from cache
ojacques Sep 7, 2022
30d844c
Bump to 1.1.1 to fix error with cache
ojacques Sep 19, 2022
bc74a24
Merge branch 'master' into master
ojacques Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
run: |
pip install .
pip install \
"mkdocs-git-committers-plugin-2<1" \
"mkdocs-git-committers-plugin-2>=1.0.2" \
"mkdocs-git-revision-date-localized-plugin>=1.0" \
"mkdocs-minify-plugin>=0.3" \
"mkdocs-redirects>=1.0"
Expand Down
5 changes: 0 additions & 5 deletions docs/schema/plugins/external/git-committers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
"type": "string"
},
"token": {
"title": "Personal access token",
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
"type": "string"
}
},
"additionalProperties": false,
"required": [
Expand Down
16 changes: 5 additions & 11 deletions docs/setup/adding-a-git-repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,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 @@ -250,21 +250,15 @@ The following configuration options are supported:
repository: squidfunk/mkdocs-material
```

`token`{ #committers-repository }
`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