Update documentation

projectsyn · Jun 3, 2024 · b8ca553 · b8ca553
1 parent c586604
commit b8ca553
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/modules/ROOT/pages/explanation/compilation-metadata.adoc b/docs/modules/ROOT/pages/explanation/compilation-metadata.adoc
@@ -0,0 +1,17 @@
+= Compilation metadata reporting
+
+The reporting is implemented according to https://syn.tools/syn/SDDs/0031-component-version-tracking.html[SDD 0031 - Central Component Version tracking].
+
+Commodore will only report metadata for catalog compilations that result in a new catalog commit which was successfully pushed to the catalog repository.
+
+Currently, Commodore reports the following metadata:
+
+* Component instance URLs, versions, subpaths, and Git commit hashes
+* Package URLs, versions, subpaths, and Git commit hashes
+* Global repo URL, version and Git commit hash
+* Tenant repo URL, version and Git commit hash
+* Commodore Python package version and Git version
+* The timestamp of the successful compilation
+
+
+Commodore uses the same data that's reported to Lieutenant to generate the catalog commit message.
diff --git a/docs/modules/ROOT/partials/nav-explanation.adoc b/docs/modules/ROOT/partials/nav-explanation.adoc
@@ -2,3 +2,4 @@
 * xref:commodore:ROOT:explanation/dependencies.adoc[Manage Dependencies]
 * xref:commodore:ROOT:explanation/running-commodore.adoc[Running Commodore]
 * xref:commodore:ROOT:explanation/migrate-kapitan-0.29-0.30.adoc[Migrating from Kapitan 0.29 to 0.30]
+* xref:commodore:ROOT:explanation/compilation-metadata.adoc[]