From 9141562f911a87a2d578e0de856733507b39caf8 Mon Sep 17 00:00:00 2001 From: Bernd Storath <999999bst@gmail.com> Date: Wed, 4 Feb 2026 08:17:58 +0100 Subject: [PATCH] update tagging convention for latest tag --- docs/content/getting-started.md | 4 ++-- docs/content/index.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md index c58f6827..406fbf90 100644 --- a/docs/content/getting-started.md +++ b/docs/content/getting-started.md @@ -45,15 +45,15 @@ All workflows are using the tagging convention listed below. It is subsequently | tag | Type | Example | Description | | ------------- | ------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `15` | latest minor for that major tag | `ghcr.io/wg-easy/wg-easy:15` | latest features for specific major versions, no breaking changes, recommended | -| `latest` | latest tag | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | points to latest release, can include breaking changes | | `15.0` | latest patch for that minor tag | `ghcr.io/wg-easy/wg-easy:15.0` | latest patches for specific minor version | | `15.0.0` | specific tag | `ghcr.io/wg-easy/wg-easy:15.0.0` | specific release, no updates | | `edge` | push to `master` | `ghcr.io/wg-easy/wg-easy:edge` | mostly unstable, gets frequent package and code updates | | `development` | pull requests | `ghcr.io/wg-easy/wg-easy:development` | used for development, testing code from PRs | +| `latest` | latest tag | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | points to the v14 release, should be avoided | -When publishing a tag we follow the [Semantic Versioning][semver] specification. The `latest` tag is always pointing to the latest stable release. If you want to avoid breaking changes, use the major version tag (e.g. `15`). +When publishing a tag we follow the [Semantic Versioning][semver] specification. Pin to the latest major version to avoid breaking changes (e.g. `15`), avoid using the `latest` tag. [github-ci]: https://github.com/wg-easy/wg-easy/actions [ghcr-image]: https://github.com/wg-easy/wg-easy/pkgs/container/wg-easy diff --git a/docs/content/index.md b/docs/content/index.md index 2e2c3235..e15fd9c0 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -8,7 +8,7 @@ hide: /// info | This Documentation is Versioned -**Make sure** to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the `:latest` image tag - [the most recent stable release][docs-tagging]. +**Make sure** to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to [the most recent stable release][docs-tagging]. /// This documentation provides you not only with the basic setup and configuration of `wg-easy` but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.