From e39e0ceae008f2c8a886c524406569701426e348 Mon Sep 17 00:00:00 2001
From: Dan Barr <dan@stacklok.com>
Date: Tue, 7 Jan 2025 16:56:41 -0500
Subject: [PATCH] Add changelog and install notes about image tags

---
 docs/about/changelog.md | 16 ++++++++++++++++
 docs/how-to/install.md  | 12 +++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/docs/about/changelog.md b/docs/about/changelog.md
index d7eabf1..0d4b86e 100644
--- a/docs/about/changelog.md
+++ b/docs/about/changelog.md
@@ -4,6 +4,22 @@ description: History of notable updates and changes to CodeGate
 sidebar_position: 20
 ---
 
+:::info
+
+Major features and changes are noted here. To review all updates, see the
+[GitHub Releases page](https://github.com/stacklok/codegate/releases).
+
+:::
+
+- **Semantic versioning for container image** - 8 Jan, 2025\
+  Starting with v0.1.4, the CodeGate container image is published with semantic
+  version tags corresponding to
+  [GitHub releases](https://github.com/stacklok/codegate/releases). You can
+  optionally pull using the major (`v0`), minor (`v0.1`), or patch version
+  (`v0.1.4`) to explicitly control the version you're running. \
+  CodeGate is evolving quickly, so we still recommend pulling the `latest` tag
+  so you don't miss out on new features and updates to package risk data.
+
 - **UI port change** - 7 Jan, 2025\
   The internal port for the dashboard UI has changed from 80 to 9090 to resolve
   a permissions issue for Linux users.
diff --git a/docs/how-to/install.md b/docs/how-to/install.md
index 86fe3f1..6a2dac0 100644
--- a/docs/how-to/install.md
+++ b/docs/how-to/install.md
@@ -48,7 +48,7 @@ Run with minimal functionality for use with **Continue**:
 docker run -d -p 8989:8989 -p 9090:9090 --restart unless-stopped ghcr.io/stacklok/codegate:latest
 ```
 
-Mount a **persistent volume** to the container (see
+**Mount a persistent volume** to the container (see
 [Persisting dashboard data](./dashboard.md#persisting-dashboard-data)):
 
 ```bash
@@ -62,6 +62,16 @@ docker run --name codegate -d -p 8989:8989 -p 9090:9090 --mount type=volume,src=
 docker run --name codegate -d -p 8989:8989 -p 9090:9090 -p 8990:8990 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
 ```
 
+**Install a specific version:** starting with v0.1.4 you can optionally run a
+specific version of CodeGate using sematic version tags:
+
+- Patch version: `ghcr.io/stacklok/codegate:v0.1.4` (exact)
+- Minor version: `ghcr.io/stacklok/codegate:v0.1` (latest v0.1.x release)
+- Major version: `ghcr.io/stacklok/codegate:v0` (latest v0.x.x release)
+
+See the [GitHub releases](https://github.com/stacklok/codegate/releases) page
+for available versions.
+
 :::tip
 
 Record the `docker run` command you use to launch CodeGate. It will be a handy