Skip to content

Commit db44898

Browse files
authored
Add changelog and install notes about image tags (#26)
1 parent eb9b799 commit db44898

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

docs/about/changelog.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ description: History of notable updates and changes to CodeGate
44
sidebar_position: 20
55
---
66

7+
:::info
8+
9+
Major features and changes are noted here. To review all updates, see the
10+
[GitHub Releases page](https://github.com/stacklok/codegate/releases).
11+
12+
:::
13+
14+
- **Semantic versioning for container image** - 8 Jan, 2025\
15+
Starting with v0.1.4, the CodeGate container image is published with semantic
16+
version tags corresponding to
17+
[GitHub releases](https://github.com/stacklok/codegate/releases). You can
18+
optionally pull using the major (`v0`), minor (`v0.1`), or patch version
19+
(`v0.1.4`) to explicitly control the version you're running. \
20+
CodeGate is evolving quickly, so we still recommend pulling the `latest` tag
21+
so you don't miss out on new features and updates to package risk data.
22+
723
- **UI port change** - 7 Jan, 2025\
824
The internal port for the dashboard UI has changed from 80 to 9090 to resolve
925
a permissions issue for Linux users.

docs/how-to/install.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Run with minimal functionality for use with **Continue**:
4848
docker run -d -p 8989:8989 -p 9090:9090 --restart unless-stopped ghcr.io/stacklok/codegate:latest
4949
```
5050

51-
Mount a **persistent volume** to the container (see
51+
**Mount a persistent volume** to the container (see
5252
[Persisting dashboard data](./dashboard.md#persisting-dashboard-data)):
5353

5454
```bash
@@ -62,6 +62,16 @@ docker run --name codegate -d -p 8989:8989 -p 9090:9090 --mount type=volume,src=
6262
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
6363
```
6464

65+
**Install a specific version:** starting with v0.1.4 you can optionally run a
66+
specific version of CodeGate using sematic version tags:
67+
68+
- Patch version: `ghcr.io/stacklok/codegate:v0.1.4` (exact)
69+
- Minor version: `ghcr.io/stacklok/codegate:v0.1` (latest v0.1.x release)
70+
- Major version: `ghcr.io/stacklok/codegate:v0` (latest v0.x.x release)
71+
72+
See the [GitHub releases](https://github.com/stacklok/codegate/releases) page
73+
for available versions.
74+
6575
:::tip
6676

6777
Record the `docker run` command you use to launch CodeGate. It will be a handy

0 commit comments

Comments
 (0)