Cut v4.0.0 release (#20)

Author: jthomperoo

CHANGELOG.md

@@ -5,11 +5,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [v4.0.0] - 2024-04-21
 ### Changed
-- Updated minimum Go version to `v1.22`.
+- **BREAKING CHANGE** Changed module path from `github.com/jthomperoo/k8shorizmetrics/v3` to
+`github.com/jthomperoo/k8shorizmetrics/v4`.
 - **BREAKING CHANGE** Types now use JSON tags which match Kubernetes convention, with naming using camel case rather
-than snake case. For example the Resource Metric field `PodMetricsInfo` is now serialized as `podMetricsInfo` rather
+than snake case. For example the Resource Metric field `PodMetricsInfo` is now serialised as `podMetricsInfo` rather
 than `pod_metrics_info`.
+- Updated minimum Go version to `v1.22`.
 
 ## [v3.0.0] - 2024-03-21
 ### Changed
@@ -61,7 +65,8 @@ call time as a parameter.
 - Allows insights into how the HPA makes decisions.
 - Supports scaling to and from 0.
 
-[Unreleased]: https://github.com/jthomperoo/k8shorizmetrics/compare/v3.0.0...HEAD
+[Unreleased]: https://github.com/jthomperoo/k8shorizmetrics/compare/v4.0.0...HEAD
+[v4.0.0]: https://github.com/jthomperoo/k8shorizmetrics/compare/v3.0.0...v4.0.0
 [v3.0.0]: https://github.com/jthomperoo/k8shorizmetrics/compare/v2.0.2...v3.0.0
 [v2.0.2]: https://github.com/jthomperoo/k8shorizmetrics/compare/v2.0.1...v2.0.2
 [v2.0.1]: https://github.com/jthomperoo/k8shorizmetrics/compare/v2.0.0...v2.0.1

README.md

@@ -1,7 +1,7 @@
 [![Build](https://github.com/jthomperoo/k8shorizmetrics/workflows/main/badge.svg)](https://github.com/jthomperoo/k8shorizmetrics/actions)
-[![go.dev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/jthomperoo/k8shorizmetrics/v3)
+[![go.dev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/jthomperoo/k8shorizmetrics/v4)
 [![Go Report
-Card](https://goreportcard.com/badge/github.com/jthomperoo/k8shorizmetrics/v3)](https://goreportcard.com/report/github.com/jthomperoo/k8shorizmetrics/v3)
+Card](https://goreportcard.com/badge/github.com/jthomperoo/k8shorizmetrics/v4)](https://goreportcard.com/report/github.com/jthomperoo/k8shorizmetrics/v4)
 [![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
 
 # k8shorizmetrics
@@ -13,7 +13,7 @@ to work out the target replica count that the HPA does.
 ## Install
 
 ```bash
-go get -u github.com/jthomperoo/k8shorizmetrics/v3@v3.0.0
+go get -u github.com/jthomperoo/k8shorizmetrics/v4@v4.0.0
 ```
 
 ## Features
@@ -89,7 +89,7 @@ func main() {
 
 ## Documentation
 
-See the [Go doc](https://pkg.go.dev/github.com/jthomperoo/k8shorizmetrics/v3).
+See the [Go doc](https://pkg.go.dev/github.com/jthomperoo/k8shorizmetrics/v4).
 
 ## Migration
 
@@ -138,6 +138,17 @@ if err != nil {
 
 You can use similar code for the `Evaluate` method of the `Evaluater`.
 
+### From v3 to v4
+
+To update to `v4` you will need to update all references in your code that refer to
+`github.com/jthomperoo/k8shorizmetrics/v3` to use `github.com/jthomperoo/k8shorizmetrics/v4`.
+
+The only behaviour change is around serialisation into JSON. Fields are now serialised using camel case rather
+than snake case to match the Kubernetes conventions.
+
+If you are relying on JSON serialised values you need to use camel case now. For example the Resource Metric field
+`PodMetricsInfo` is now serialised as `podMetricsInfo` ratherthan `pod_metrics_info`.
+
 ## Examples
 
 See the [examples directory](./examples/) for some examples, [cpuprint](./examples/cpuprint/) is a good start.

evaluate.go

@@ -30,12 +30,12 @@ package k8shorizmetrics
 import (
 	"fmt"
 
-	"github.com/jthomperoo/k8shorizmetrics/v3/internal/external"
-	"github.com/jthomperoo/k8shorizmetrics/v3/internal/object"
-	"github.com/jthomperoo/k8shorizmetrics/v3/internal/pods"
-	"github.com/jthomperoo/k8shorizmetrics/v3/internal/replicas"
-	"github.com/jthomperoo/k8shorizmetrics/v3/internal/resource"
-	"github.com/jthomperoo/k8shorizmetrics/v3/metrics"
+	"github.com/jthomperoo/k8shorizmetrics/v4/internal/external"
+	"github.com/jthomperoo/k8shorizmetrics/v4/internal/object"
+	"github.com/jthomperoo/k8shorizmetrics/v4/internal/pods"
+	"github.com/jthomperoo/k8shorizmetrics/v4/internal/replicas"
+	"github.com/jthomperoo/k8shorizmetrics/v4/internal/resource"
+	"github.com/jthomperoo/k8shorizmetrics/v4/metrics"
 	autoscalingv2 "k8s.io/api/autoscaling/v2"
 )
 

evaluate_test.go

@@ -21,9 +21,9 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/jthomperoo/k8shorizmetrics/v3"
-	"github.com/jthomperoo/k8shorizmetrics/v3/internal/fake"
-	"github.com/jthomperoo/k8shorizmetrics/v3/metrics"
+	"github.com/jthomperoo/k8shorizmetrics/v4"
+	"github.com/jthomperoo/k8shorizmetrics/v4/internal/fake"
+	"github.com/jthomperoo/k8shorizmetrics/v4/metrics"
 	v2 "k8s.io/api/autoscaling/v2"
 )
 

examples/cpuandmemoryreplicaprint/go.mod

@@ -5,7 +5,7 @@ go 1.22.0
 toolchain go1.22.2
 
 require (
-	github.com/jthomperoo/k8shorizmetrics/v3 v3.0.0
+	github.com/jthomperoo/k8shorizmetrics/v4 v4.0.0
 	k8s.io/api v0.30.0
 	k8s.io/apimachinery v0.30.0
 	k8s.io/client-go v0.30.0
@@ -57,4 +57,4 @@ require (
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
 
-replace github.com/jthomperoo/k8shorizmetrics/v3 => ../../
+replace github.com/jthomperoo/k8shorizmetrics/v4 => ../../

examples/cpuandmemoryreplicaprint/main.go

@@ -23,9 +23,9 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/jthomperoo/k8shorizmetrics/v3"
-	"github.com/jthomperoo/k8shorizmetrics/v3/metricsclient"
-	"github.com/jthomperoo/k8shorizmetrics/v3/podsclient"
+	"github.com/jthomperoo/k8shorizmetrics/v4"
+	"github.com/jthomperoo/k8shorizmetrics/v4/metricsclient"
+	"github.com/jthomperoo/k8shorizmetrics/v4/podsclient"
 	v2 "k8s.io/api/autoscaling/v2"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

examples/cpuprint/go.mod

@@ -5,7 +5,7 @@ go 1.22.0
 toolchain go1.22.2
 
 require (
-	github.com/jthomperoo/k8shorizmetrics/v3 v3.0.0
+	github.com/jthomperoo/k8shorizmetrics/v4 v4.0.0
 	k8s.io/api v0.30.0
 	k8s.io/apimachinery v0.30.0
 	k8s.io/client-go v0.30.0
@@ -57,4 +57,4 @@ require (
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
 
-replace github.com/jthomperoo/k8shorizmetrics/v3 => ../../
+replace github.com/jthomperoo/k8shorizmetrics/v4 => ../../

examples/cpuprint/main.go

@@ -21,9 +21,9 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/jthomperoo/k8shorizmetrics/v3"
-	"github.com/jthomperoo/k8shorizmetrics/v3/metricsclient"
-	"github.com/jthomperoo/k8shorizmetrics/v3/podsclient"
+	"github.com/jthomperoo/k8shorizmetrics/v4"
+	"github.com/jthomperoo/k8shorizmetrics/v4/metricsclient"
+	"github.com/jthomperoo/k8shorizmetrics/v4/podsclient"
 	v2 "k8s.io/api/autoscaling/v2"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/labels"

examples/cpureplicaprint/go.mod

@@ -5,7 +5,7 @@ go 1.22.0
 toolchain go1.22.2
 
 require (
-	github.com/jthomperoo/k8shorizmetrics/v3 v3.0.0
+	github.com/jthomperoo/k8shorizmetrics/v4 v4.0.0
 	k8s.io/api v0.30.0
 	k8s.io/apimachinery v0.30.0
 	k8s.io/client-go v0.30.0
@@ -57,4 +57,4 @@ require (
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
 
-replace github.com/jthomperoo/k8shorizmetrics/v3 => ../../
+replace github.com/jthomperoo/k8shorizmetrics/v4 => ../../

examples/cpureplicaprint/main.go

@@ -22,9 +22,9 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/jthomperoo/k8shorizmetrics/v3"
-	"github.com/jthomperoo/k8shorizmetrics/v3/metricsclient"
-	"github.com/jthomperoo/k8shorizmetrics/v3/podsclient"
+	"github.com/jthomperoo/k8shorizmetrics/v4"
+	"github.com/jthomperoo/k8shorizmetrics/v4/metricsclient"
+	"github.com/jthomperoo/k8shorizmetrics/v4/podsclient"
 	v2 "k8s.io/api/autoscaling/v2"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"