Implement versioning ADR (#511)

* Add release GHA

Signed-off-by: Vatsal Parekh <[email protected]>

* Add Versioning ADR doc

Signed-off-by: Vatsal Parekh <[email protected]>

* Update VERSION.md

Co-authored-by: Tom Lebreux <[email protected]>

---------

Signed-off-by: Vatsal Parekh <[email protected]>
Co-authored-by: Tom Lebreux <[email protected]>

Author: vatsalparekh

.github/workflows/release.yaml

@@ -0,0 +1,25 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name : Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - name: Create release on Github
+        env:
+          GH_TOKEN:  ${{ github.token }}
+        run: |
+          if [[ "${{ github.ref_name }}" == *-rc* ]]; then
+            gh --repo "${{ github.repository }}" release create ${{ github.ref_name }} --verify-tag --generate-notes --prerelease
+          else
+            gh --repo "${{ github.repository }}" release create ${{ github.ref_name }} --verify-tag --generate-notes
+          fi

README.md

@@ -361,3 +361,7 @@ type FooCache interface {
 type FooIndexer func(obj *v1alpha1.Foo) ([]string, error)
 
 ```
+
+# Versioning
+
+See [VERSION.md](VERSION.md).

VERSION.md

@@ -0,0 +1,21 @@
+Each wrangler major version supports a range of Kubernetes minor versions. The range supported by each major release line is include below. Wrangler follows the following rules for changes between major/minor/patch:
+
+<ins>Major Version Increases</ins>:
+- Support for a kubernetes version is explicitly removed (note that this means that wrangler uses a feature that does not work on this version).
+- A breaking change is made, which is not necessary to resolve a defect.
+
+<ins>Minor Version Increases</ins>:
+- Support for a kubernetes version is added.
+- A breaking change in an exported function is made to resolve a defect.
+
+<ins>Patch Version Increases</ins>
+- A bug was fixed.
+- A feature was added, in a backwards-compatible way.
+- A breaking change in an exported function is made to resolve a CVE.
+
+The current supported release lines are:
+
+| Wrangler Branch | Wrangler Major version | Supported Kubernetes Versions |
+|--------------------------|------------------------------------|------------------------------------------------|
+| main | v3 | v1.26 - v1.32 |
+| release/v2 | v2 | v1.23 - v1.26 |