aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gen/git-version
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gen/git-version')
-rwxr-xr-xdocs/gen/git-version25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/gen/git-version b/docs/gen/git-version
new file mode 100755
index 0000000..495b679
--- /dev/null
+++ b/docs/gen/git-version
@@ -0,0 +1,25 @@
+#!/bin/sh
+
+TAG=$(git describe --abbrev=0 HEAD)
+# REV_SHORT=$(git rev-parse --short HEAD)
+# REV_LONG=$(git rev-parse HEAD)
+
+cat <<EOF
+----
+-- \`alive\` source code version information.
+--
+-- @module version
+
+--- exports
+-- @table exports
+-- @tfield string tag the last versions git tag
+-- @tfield string web the repo web URL
+-- @tfield string repo the git repo URL
+-- @tfield string release the web URL of this release
+{
+ tag: "${TAG}"
+ web: "https://github.com/s-ol/alivecoding"
+ repo: "https://github.com/s-ol/alivecoding.git"
+ release: "https://github.com/s-ol/alivecoding/releases/tag/${TAG}"
+}
+EOF