diff --git a/README.md b/README.md index 35bbfc9..624b9bf 100644 --- a/README.md +++ b/README.md @@ -40,19 +40,14 @@ The [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme suppor See the [documentation](https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html) on how to fine-tune the appearance and the date format. -### Note when using build environments +### **Note when using build systems like Github Actions** -This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to: - -
- Change your CI settings - -
+This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many CI/CD build systems only retrieve the last commit, which means you might need to change your CI/CD settings: +- Github Actions: set `fetch-depth` to `0` (docs) +- Gitlab Runners: set `GIT_DEPTH` to `0` (docs) +- Bitbucket pipelines: set `clone: depth: full` (docs) +- Azure Devops pipelines: set `Agent.Source.Git.ShallowFetchDepth` to something very high like `10e99` ([docs](https://docs.microsoft.com/en-us/azure/devops/pipelines/repos/pipeline-options-for-git?view=azure-devops#shallow-fetch)) ## Documentation