#132: Add option to fix shallow repositories

mtkennerly · Jul 10, 2023 · 41c868d · 41c868d
1 parent 40003d9
commit 41c868d
Show file tree

Hide file tree

Showing 5 changed files with 938 additions and 966 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## Unreleased
+
+* Added:
+  * `fix-shallow-repository` option to attempt to automatically fix shallow repositories.
+    Currently, this only supports Git and will run `git fetch --tags`.
+* Changed:
+  * Updated Dunamai to 1.18.0+ for the latest features.
+
 ## v0.24.0 (2023-06-30)
 
 * Added:

diff --git a/README.md b/README.md
@@ -196,6 +196,9 @@ In your pyproject.toml file, you may configure the following options:
     instead of the short form. This is only used for Git and Mercurial.
   * `strict` (boolean, default: false):
     If true, then fail instead of falling back to 0.0.0 when there are no tags.
+  * `fix-shallow-repository` (boolean, default: false):
+    If true, then automatically try to fix shallow repositories.
+    Currently, this only supports Git and will run `git fetch --tags`.
 * `[tool.poetry-dynamic-versioning.substitution]`: Insert the dynamic version
   into additional files other than just pyproject.toml. These changes will be
   reverted when the plugin deactivates.