From a551e2c483d0f3ab93822dd3385d572eefd74930 Mon Sep 17 00:00:00 2001 From: Olivier Jacques Date: Wed, 31 Aug 2022 22:57:27 +0200 Subject: [PATCH 1/4] Updated git-committers to 1.0.0 --- .github/workflows/documentation.yml | 2 +- docs/schema/plugins/external/git-committers.json | 5 ----- docs/setup/adding-a-git-repository.md | 16 +++++----------- 3 files changed, 6 insertions(+), 17 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index f426aca1a..5ff93142d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -57,7 +57,7 @@ jobs: run: | 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-minify-plugin>=0.3" \ "mkdocs-redirects>=1.0" diff --git a/docs/schema/plugins/external/git-committers.json b/docs/schema/plugins/external/git-committers.json index c6c43f0ab..018075312 100644 --- a/docs/schema/plugins/external/git-committers.json +++ b/docs/schema/plugins/external/git-committers.json @@ -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": [ diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 6da55fd13..064ce3e1e 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -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: @@ -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 From 023af66dc0a81f546e73632c775e40a23b98cb2d Mon Sep 17 00:00:00 2001 From: Olivier Jacques Date: Sun, 4 Sep 2022 08:28:41 +0200 Subject: [PATCH 2/4] Bumping to 1.0.2 --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index f8ee0f2ba..c579d0ea1 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -57,7 +57,7 @@ jobs: run: | pip install . pip install \ - "mkdocs-git-committers-plugin-2>=1.0.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" From 52ff9da7b9020a16586629012d51b41bda0e3e59 Mon Sep 17 00:00:00 2001 From: Olivier Jacques Date: Thu, 8 Sep 2022 00:10:54 +0200 Subject: [PATCH 3/4] Bump to 1.1.0 to benefit from cache --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index c579d0ea1..1cbdab293 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -57,7 +57,7 @@ jobs: run: | pip install . pip install \ - "mkdocs-git-committers-plugin-2>=1.0.2" \ + "mkdocs-git-committers-plugin-2>=1.1.0" \ "mkdocs-git-revision-date-localized-plugin>=1.0" \ "mkdocs-minify-plugin>=0.3" \ "mkdocs-redirects>=1.0" From 30d844cc1e2273476de1d7b7f4332f9548d80578 Mon Sep 17 00:00:00 2001 From: Olivier Jacques Date: Mon, 19 Sep 2022 21:24:50 +0200 Subject: [PATCH 4/4] Bump to 1.1.1 to fix error with cache --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 1cbdab293..935660927 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -57,7 +57,7 @@ jobs: run: | pip install . pip install \ - "mkdocs-git-committers-plugin-2>=1.1.0" \ + "mkdocs-git-committers-plugin-2>=1.1.1" \ "mkdocs-git-revision-date-localized-plugin>=1.0" \ "mkdocs-minify-plugin>=0.3" \ "mkdocs-redirects>=1.0"