📦 Support Versioning in Git Archives (#187)

burgholzer · web-flow · commit 3b8dab3337fd · 2022-10-30T10:25:04.000Z
Following https://scikit-hep.org/developer/packaging#versioning-mediumhigh-priority, this PR adds the necessary steps to allow git archives (including the ones generated from GitHub) to also support versioning. This requires `setuptools_scm>=7`. Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
diff --git a/.git_archival.txt b/.git_archival.txt
@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
 test/circuits/** linguist-vendored
+.git_archival.txt  export-subst
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=61",
-    "setuptools_scm[toml]>=6.4",
+    "setuptools_scm[toml]>=7",
     "ninja>=1.10; sys_platform != 'win32'",
     "cmake>=3.14",
 ]

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`test/circuits/** linguist-vendored`
	`2`	`+.git_archival.txt export-subst`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`[build-system]`
`2`	`2`	`requires = [`
`3`	`3`	`"setuptools>=61",`
`4`		`- "setuptools_scm[toml]>=6.4",`
	`4`	`+ "setuptools_scm[toml]>=7",`
`5`	`5`	`"ninja>=1.10; sys_platform != 'win32'",`
`6`	`6`	`"cmake>=3.14",`
`7`	`7`	`]`