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: 03a6d4e After the PR is merged, everytime the `auto3dseg` folder is changed, this file should also be changed. --------- Signed-off-by: Yiheng Wang <[email protected]>
Project-MONAI · Oct 25, 2023 · ba00ecc · ba00ecc
1 parent 9903d2c
commit ba00ecc
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git 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
@@ -0,0 +1,6 @@
+{
+    "version": "0.0.1",
+    "changelog": {
+        "0.0.1": "this version is based on commit 03a6d4effb9223670f439c3a29198ef34938922f"
+    }
+}