feat: add Makefile rule to sync chart version

Author: ssncferreira

.github/workflows/lint.yaml

@@ -13,6 +13,12 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Required for fetch git tags step
+
+      # Ensure git tags are available for version scripts
+      - name: Fetch git tags
+        run: git fetch --tags --force
 
       - name: Setup Go
         uses: actions/setup-go@v2

Makefile

@@ -33,14 +33,26 @@ lint/helm/prometheus-rules:
 
 .PHONY: lint/helm/prometheus-rules
 
+# Set coder-observability/Chart.yaml version to the latest stable git tag
+# TODO: auto-update chart version in Chart.yaml when a new release is published
+chart/version-sync:
+	version=$(shell ./scripts/version.sh -s) && \
+	if [ -z "$$version" ]; then \
+		echo "No git tag found. Cannot set Chart.yaml version" >&2; \
+		exit 1; \
+	fi; \
+	yq -i e ".version = \"$$version\"" coder-observability/Chart.yaml
+.PHONY: chart/version-sync
+
 # Usage: publish-patch, publish-minor, publish-major
 # Publishing is handled by GitHub Actions, triggered by tag creation.
 publish-%:
 	version=$(shell ./scripts/version.sh --bump $*) && \
-	git tag --sign "$$version"  -m "Release: $$version" && \
+	git tag --sign "$$version" -m "Release: $$version" && \
 	git push origin tag "$$version"
 
-readme:
+# TODO: auto-update chart version in README files when a new release is published
+readme: chart/version-sync
 	go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
 	helm-docs --output-file ../README.md \
 		--values-file=values.yaml --chart-search-root=coder-observability --template-files=../README.gotmpl

PUBLISH.md

@@ -1,4 +1,29 @@
 # Publishing the Coder Observability Chart
 
-- make desired changes
-- run `make publish-{major|minor|patch}` which creates & pushes a new tag, which kicks off a GH Action to publish the chart
+This repo supports both official (stable) releases and release candidates (RCs).
+
+## Official release (stable)
+
+Use this when you’re ready to publish a new release.
+
+1) Make desired changes and ensure CI is green
+2) Cut and push a new tag:
+    - Patch: `make publish-patch`
+    - Minor: `make publish-minor`
+    - Major: `make publish-major`
+
+This creates and pushes a new stable tag (e.g., 0.4.1), which kicks off a GitHub Action to package and publish the chart.
+
+## Release candidate (RC)
+
+To create a new RC version:
+
+```shell
+VERSION=v0.4.0-rc.1
+git tag "$VERSION" -m "Release: $VERSION"
+git push origin tag "$VERSION"
+```
+
+## Helm repo
+
+Use Artifact Hub to browse/search releases: https://artifacthub.io/packages/helm/coder-observability/coder-observability

README.gotmpl

@@ -20,11 +20,9 @@ Logs will be scraped from all pods in the Kubernetes cluster.
 
 ## Installation
 
-<!-- TODO: auto-update version here from publish script -->
-
 ```bash
 helm repo add coder-observability https://helm.coder.com/observability
-helm upgrade --install coder-observability coder-observability/coder-observability --version 0.1.1 --namespace coder-observability --create-namespace
+helm upgrade --install coder-observability coder-observability/coder-observability --version {{ template "chart.version" . }} --namespace coder-observability --create-namespace
 ```
 
 ## Requirements

README.md

@@ -20,11 +20,9 @@ Logs will be scraped from all pods in the Kubernetes cluster.
 
 ## Installation
 
-<!-- TODO: auto-update version here from publish script -->
-
 ```bash
 helm repo add coder-observability https://helm.coder.com/observability
-helm upgrade --install coder-observability coder-observability/coder-observability --version 0.1.1 --namespace coder-observability --create-namespace
+helm upgrade --install coder-observability coder-observability/coder-observability --version 0.3.5 --namespace coder-observability --create-namespace
 ```
 
 ## Requirements

coder-observability/Chart.yaml

@@ -1,9 +1,8 @@
 apiVersion: v2
 name: coder-observability
 description: Gain insights into your Coder deployment
-
 type: application
-version: 0.1.0
+version: 0.3.5
 dependencies:
   - name: pyroscope
     condition: pyroscope.enabled
@@ -39,4 +38,4 @@ sources:
   - https://github.com/coder/observability
 icon: https://helm.coder.com/coder_logo_black.png
 annotations:
-  artifacthub.io/category: monitoring-logging
+  artifacthub.io/category: monitoring-logging

scripts/version.sh

@@ -8,14 +8,18 @@
 set -euo pipefail
 
 remote_url=$(git remote get-url origin)
+# Newest tag by semantic version (may include prerelease like -rc/-beta/-alpha)
 current_version="$(git tag -l | sort --version-sort | tail -n1)"
+# Newest stable version tag (strict X.Y.Z; excludes prereleases)
+stable_version="$(git tag -l | sort --version-sort | grep -E '^(v)?[0-9]+\.[0-9]+\.[0-9]+$' | tail -n1)"
 
 function help() {
     echo "$0 [options] [arguments]"
     echo " "
     echo "options:"
     echo "-h, --help      show brief help"
     echo "-c, --current   show the current version"
+    echo "-s, --stable    show the current stable version"
     echo "-b, --bump      bump the version based on the given argument"
     exit 0
 }
@@ -25,11 +29,11 @@ function bump_version() {
   local new_version
 
   if [[ $version == "major" ]]; then
-    new_version=$(echo $current_version | sed 's/^v//' | awk -F. '{print "v" $1+1".0.0"}')
+    new_version=$(echo $stable_version | sed 's/^v//' | awk -F. '{print "v" $1+1".0.0"}')
   elif [[ $version == "minor" ]]; then
-    new_version=$(echo $current_version | awk -F. '{print $1"."$2+1".0"}')
+    new_version=$(echo $stable_version | awk -F. '{print $1"."$2+1".0"}')
   elif [[ $version == "patch" ]]; then
-    new_version=$(echo $current_version | awk -F. '{print $1"."$2"."$3+1}')
+    new_version=$(echo $stable_version | awk -F. '{print $1"."$2"."$3+1}')
   else
     echo "Error: Unknown argument $version"
     exit 1
@@ -38,11 +42,16 @@ function bump_version() {
   echo $new_version
 }
 
+# Show the newest tag (stable or prerelease like -rc/-beta/-alpha), without the leading 'v'.
 function show_current() {
-    # Version without the "v" prefix.
     echo "${current_version#v}"
 }
 
+# Show the newest stable tag (strict X.Y.Z), without the leading 'v'.
+function show_stable() {
+    echo "${stable_version#v}"
+}
+
 if [ $# == 0 ]; then
   show_current
 fi
@@ -56,6 +65,10 @@ while test $# -gt 0; do
       show_current
       shift
       ;;
+    -s|--stable)
+      show_stable
+      shift
+      ;;
     -b|--bump)
       if [ $# -lt 2 ]; then
         echo "Error: Missing argument for bump"