Add metadata.yaml for defining contracts

Author: cpanato

Makefile

@@ -352,6 +352,7 @@ release: clean-release  ## Builds and push container images using the latest git
 	$(MAKE) set-manifest-pull-policy PULL_POLICY=IfNotPresent
 	$(MAKE) release-manifests
 	$(MAKE) release-templates
+	$(MAKE) release-metadata
 
 .PHONY: release-manifests
 release-manifests: $(KUSTOMIZE) $(RELEASE_DIR) ## Builds the manifests to publish with a release
@@ -361,6 +362,10 @@ release-manifests: $(KUSTOMIZE) $(RELEASE_DIR) ## Builds the manifests to publis
 release-templates: $(RELEASE_DIR)
 	cp templates/cluster-template* $(RELEASE_DIR)/
 
+.PHONY: release-metadata
+release-metadata: $(RELEASE_DIR)
+	cp metadata.yaml $(RELEASE_DIR)/metadata.yaml
+
 .PHONY: release-binary
 release-binary: $(RELEASE_DIR)
 	docker run \

docs/releasing.md

@@ -1,7 +1,7 @@
 # Release Process
 
-## Change milestone 	
- - Change milestone applier so new changes can be applied to the appropriate release 
+## Change milestone
+ - Change milestone applier so new changes can be applied to the appropriate release
       - Open a PR in https://github.com/kubernetes/test-infra to change this [line](https://github.com/kubernetes/test-infra/blob/25db54eb9d52e08c16b3601726d8f154f8741025/config/prow/plugins.yaml#L344)
 - Example PR: https://github.com/kubernetes/test-infra/pull/16827
 
@@ -10,30 +10,31 @@
  - Fast-forward the release branch to the selected commit. Always release from the release branch and not from master!
    - `git fetch upstream`
    - `git merge --ff-only upstream/master`
- - Create tag with git 
+ - Create tag with git
    - `export RELEASE_TAG=v0.4.6` (the tag of the release to be cut)
    - `git tag -s ${RELEASE_TAG} -m "${RELEASE_TAG}"`
 	 - -s creates a signed tag, you must have a GPG key [added to your GitHub account](https://docs.github.com/en/enterprise/2.16/user/github/authenticating-to-github/generating-a-new-gpg-key)
    - `git push upstream ${RELEASE_TAG}`
- - `make release` from repo, this will create the release artifacts in the `out/` folder 
+ - Update the file `metadata.yaml` if is a major or minor release
+ - `make release` from repo, this will create the release artifacts in the `out/` folder
  - To install the `release-notes` tool, see https://github.com/kubernetes/release/blob/master/cmd/release-notes/README.md
  - Export GITHUB_TOKEN
  - Run the release-notes tool with the appropriate commits. Commits range from the first commit after the previous release to the new release commit.
   ```
-  release-notes --github-org kubernetes-sigs --github-repo cluster-api-provider-azure \                
+  release-notes --github-org kubernetes-sigs --github-repo cluster-api-provider-azure \
   --start-sha 1cf1ec4a1effd9340fe7370ab45b173a4979dc8f  \
-  --end-sha e843409f896981185ca31d6b4a4c939f27d975de 
+  --end-sha e843409f896981185ca31d6b4a4c939f27d975de
   ```
  - Manually format and categorize the release notes
 
-## Promote image to prod repo	
+## Promote image to prod repo
  Promote image
  - Images are built by the [post push images job](https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-azure#post-cluster-api-provider-azure-push-images)
  - Create a PR in https://github.com/kubernetes/k8s.io to add the image and tag
    - Example PR: https://github.com/kubernetes/k8s.io/pull/1030/files
  - Location of image: https://console.cloud.google.com/gcr/images/s-staging-cluster-api-azure/GLOBAL/cluster-api-azure-controller?rImageListsize=30
 
-## Release in GitHub	
+## Release in GitHub
  Create the GitHub release in the UI
  - Create a draft release in GitHub and associate it with the tag that was created
  - Copy paste the release notes
@@ -45,7 +46,7 @@
 
 cluster-api-provider-azure follows the [semantic versionining][semver] specification.
 
-As of this writing, we have not produced as a major or minor release. 
+As of this writing, we have not produced as a major or minor release.
 
 Current pre-release versions can be expected to have breaking changes as we move towards declaring a public API version.
 

metadata.yaml

@@ -0,0 +1,13 @@
+# maps release series of major.minor to cluster-api contract version
+# the contract version may change between minor or major versions, but *not*
+# between patch versions.
+#
+# update this file only when a new major or minor version is released
+apiVersion: clusterctl.cluster.x-k8s.io/v1alpha3
+releaseSeries:
+  - major: 0
+    minor: 3
+    contract: v1alpha2
+  - major: 0
+    minor: 4
+    contract: v1alpha3