From ba00ecc6c9e82678bc007d16b32c9aa056b942c8 Mon Sep 17 00:00:00 2001
From: Yiheng Wang <68361391+yiheng-wang-nv@users.noreply.github.com>
Date: Wed, 25 Oct 2023 16:52:02 +0800
Subject: [PATCH] Add metadata for auto3dseg (#325)

Address #324
This PR adds a `metadata.json` file in the `auto3dseg` folder, and it is
used to record the version and changelog.
The initial version is set to `0.0.1` which covers the changes of
commit: 03a6d4effb9223670f439c3a29198ef34938922f
After the PR is merged, everytime the `auto3dseg` folder is changed,
this file should also be changed.

---------

Signed-off-by: Yiheng Wang <vennw@nvidia.com>
---
 auto3dseg/README.md     | 4 ++++
 auto3dseg/metadata.json | 6 ++++++
 2 files changed, 10 insertions(+)
 create mode 100644 auto3dseg/metadata.json

diff --git a/auto3dseg/README.md b/auto3dseg/README.md
index 27ca6fd4..6dc39e81 100644
--- a/auto3dseg/README.md
+++ b/auto3dseg/README.md
@@ -10,6 +10,10 @@ python auto3dseg/tests/test_algo_templates.py
 python auto3dseg/tests/test_gpu_customization.py
 ```
 
+## Version control
+
+If the folder `auto3dseg` is changed, a new `version` and the corresponding `changelog` should be added into the `metadata.json` file.
+
 ## Adding new templates
 
 ### Class/Folder naming convention
diff --git a/auto3dseg/metadata.json b/auto3dseg/metadata.json
new file mode 100644
index 00000000..1a8b7437
--- /dev/null
+++ b/auto3dseg/metadata.json
@@ -0,0 +1,6 @@
+{
+    "version": "0.0.1",
+    "changelog": {
+        "0.0.1": "this version is based on commit 03a6d4effb9223670f439c3a29198ef34938922f"
+    }
+}