Add chart versioning policy

.github/workflows/product-release.yml

@@ -92,6 +92,17 @@ jobs:
 
           echo "value=$APP_VERSION" >> "$GITHUB_OUTPUT"
 
+      - name: Require pre-1.0.0 chart
+        env:
+          CHART_NAME: ${{ steps.chart.outputs.name }}
+        run: |
+          CHART_VERSION=$(yq -r '.version' "charts/${CHART_NAME}/Chart.yaml")
+          MAJOR=${CHART_VERSION%%.*}
+          if ! [[ "$MAJOR" =~ ^[0-9]+$ ]] || [ "$MAJOR" -ge 1 ]; then
+            echo "::error::Product releases require a chart version below 1.0.0; found ${CHART_VERSION}"
+            exit 1
+          fi
+
       - name: Check current appVersion
         id: current
         env:

.gitignore

@@ -18,3 +18,5 @@ _publish.yml
 
 # helm packages
 *.tgz
+
+**/*.quarto_ipynb

README.md

@@ -15,6 +15,21 @@
 > If you are upgrading from an earlier version, read the
 > [image migration guide](https://docs.posit.co/helm/docs/migrating-to-posit-images.html) first.
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## Usage
 
 1. Install [Helm](https://helm.sh). Please refer to Helm's [documentation](https://helm.sh/docs/) for more information on getting started.

charts/_templates.gotmpl

@@ -22,6 +22,25 @@ Workbench.
   {{- print "" | nindent 0 }}
   {{- print "" | nindent 0 }}
   {{- template "rstudio.blurb" . }}
+  {{- template "rstudio.versioning" . }}
+{{- end }}
+
+{{- define "rstudio.versioning" }}
+
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
 {{- end }}
 
 {{- define "rstudio.header" }}

charts/posit-chronicle/README.md

@@ -19,6 +19,21 @@ and [Connect](https://github.com/rstudio/helm/tree/main/charts/rstudio-connect#c
 organization's use of other Posit products, primarily Posit Connect and
 Workbench.
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## For production
 
 To ensure a stable production deployment:

charts/rstudio-connect/README.md

@@ -7,6 +7,21 @@
 Business Users and Collaborators use R and Python data products on [Posit Connect](https://posit.co/products/enterprise/connect/)
 that are published by Data Scientists.
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## Best practices
 
 Helm charts are very useful tools for deploying resources into Kubernetes, however, they do require

charts/rstudio-launcher-rbac/README.md

@@ -4,6 +4,21 @@
 
 #### _RBAC definition for the RStudio Job Launcher_
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## For production
 
 To ensure a stable production deployment:

charts/rstudio-library/README.md

@@ -4,6 +4,21 @@
 
 #### _Helm library helpers for use by official RStudio charts_
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## For production
 
 To ensure a stable production deployment:

charts/rstudio-pm/README.md

@@ -7,6 +7,21 @@
 IT Administrators use [Posit Package Manager](https://posit.co/products/enterprise/package-manager/) to control and manage
 R and Python packages that Data Scientists need to create and share data products.
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## For production
 
 To ensure a stable production deployment:

charts/rstudio-workbench/README.md

@@ -7,6 +7,21 @@
 Data Scientists use [Posit Workbench](https://posit.co/products/enterprise/workbench/) to analyze data and create data
 products using R and Python.
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## For production
 
 To ensure a stable production deployment:

index.qmd

@@ -17,6 +17,21 @@ See the [image migration guide](docs/migrating-to-posit-images.qmd) for details.
 
 :::
 
+## Chart versioning
+
+Chart versions use [SemVer](https://semver.org/) and follow [Helm's chart
+versioning guidance](https://helm.sh/docs/topics/charts/#charts-and-versioning). They describe the chart.
+
+Product versions belong in `appVersion`.
+
+While a chart is below `1.0.0`:
+
+- Minor: breaking changes or changes that require user action
+- Patch: product releases, enhancements, bug fixes, and other compatible changes
+- Major: not used
+
+After `1.0.0`, standard SemVer applies.
+
 ## Usage
 
 1. Install [Helm](https://helm.sh). Please refer to the [Helm documentation](https://helm.sh/docs/) for more information on getting started.