Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-18 02:15:56 +01:00
Code Issues Releases Wiki Activity

Added git-committers plugin to blog post

Browse Source
This commit is contained in:
squidfunk 2023-09-22 21:01:14 +02:00
parent d3d8964c63
commit b276146fc7
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/blog/posts/git-sparse-checkout.md
View File

@ -18,17 +18,20 @@ seconds to just 2 seconds.__
Developing an efficient approach to build documentation in CI workflows is
essential, especially when working in large repositories with thousands of
commits, like ours. Of course, we want to build documentation quickly and
efficiently, ensuring fast and productive workflows. When using the wonderful
[`git-revision-date-localized`][git-revision-date-localized] plugin to display
[document contributors] at the bottom of each page, we are required to set
`fetch-depth: 0`, which resulted in checkout times of 20 to 30 seconds on our
repository. By leveraging [`git sparse-checkout`][git sparse-checkout] within
[GitHub Actions], we were able to bring down checkout time to 2 seconds.
efficiently, ensuring fast and productive workflows. When using both the
wonderful [`git-committers`][git-committers] and [`git-revision-date-localized`]
[git-revision-date-localized] plugins to display [document contributors] and
[dates] at the bottom of each page, we are required to set `fetch-depth: 0`,
which resulted in checkout times of 20 to 30 seconds on our repository. By
leveraging [`git sparse-checkout`][git sparse-checkout] within [GitHub Actions],
we were able to bring down checkout time to 2 seconds.
[git sparse-checkout]: https://git-scm.com/docs/git-sparse-checkout
[GitHub Actions]: ../../publishing-your-site.md#with-github-actions
[git-revision-date-localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
[git-committers]: https://github.com/ojacques/mkdocs-git-committers-plugin-2
[document contributors]: ../../setup/adding-a-git-repository.md#document-contributors
[dates]: ../../setup/adding-a-git-repository.md#document-dates
<!-- more -->