Skip to content

Release

Release cycle

Currently we don’t release regularly. Whenever we think it makes sense to release a new version we do it, but we aim to do a new release every month. You might want to ask in our Slack channel external-dns when the next release will come out.

Versioning convention

These are the conventions that we will be using for releases following 0.7.6:

  • Patch version should be updated if we need to merge bugfixes, e.g. provider a does need a fix in order make updates working again. I would see updating or improving documentation here.

  • Minor version should be updated if new features are implemented in existing providers or new provider get introduced.

  • Major version should be upgraded if we introduce breaking changes.

How to release a new image

Prerequisite

We use https://github.com/cli/cli to automate the release process. Please install it according to the official documentation.

You must be an official maintainer of the project to be able to do a release.

Steps

  • Run scripts/releaser.sh to create a new GitHub release. Alternatively you can create a release in the GitHub UI making sure to click on the autogenerate release node feature.
  • The step above will trigger the Kubernetes based CI/CD system Prow. Verify that a new image was built and uploaded to gcr.io/k8s-staging-external-dns/external-dns.
  • Create a PR in the k8s.io repo (see https://github.com/kubernetes/k8s.io/pull/540 for reference) by taking the current staging image using the sha256 digest. Once the PR is merged, the image will be live with the corresponding tag specified in the PR.
  • Verify that the image is pullable with the given tag (i.e. v0.7.5).
  • Branch out from the default branch and run scripts/kustomize-version-updater.sh to update the image tag used in the kustomization.yaml.
  • Create an issue to release the corresponding Helm chart via the chart release process (below) assigned to a chart maintainer
  • Create a PR with the kustomize change.
  • Create a PR to replace all versions for docker images in the tutorials. A possible script to use is sd registry.k8s.io/external-dns/external-dns:.* registry.k8s.io/external-dns/external-dns:v0.14.2 $(fd --type file) which uses the fd and sd utilities.
  • Once the PR is merged, all is done :-)

How to release a new chart version

The chart needs to be released in response to an ExternalDNS image release or on an as-needed basis; this should be triggered by an issue to release the chart.

Steps

  • Create a PR to update Chart.yaml with the ExternalDNS version in appVersion, agreed on chart release version in version and annotations showing the changes
  • Validate that the chart linting is successful
  • Merge the PR to trigger a GitHub action to release the chart