Azure / draft

A day 0 tool for getting your app on k8s fast
MIT License
493 stars 58 forks source link

rename helm `imageKey` to `image` to match starter workflows #176

Closed davidgamero closed 1 year ago

davidgamero commented 1 year ago

Description

The recommended generated key names in draft don't line up with the keys in the starter workflows, so this PR changes the imageKey key to just image so that they are all consistent

This is a breaking change for consumers of the IMAGENAME variable, as it will no longer can contain both an image name and tag.

Previously, alpine:latest was a valid IMAGENAME, but now the IMAGETAG variable (which defaults to "latest" following docker and kubernetes convention) should be used to pass a tag.

Usages of IMAGENAME that include a tag will now need to use the IMAGETAG variable for passing a tag, as passing an image name like alpine:latest will result in double-tagging such as alpine:latest:latest

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Is it a breaking change which will impact consuming tool(s).

Checklist:

sabbour commented 1 year ago

Can we bump the version and add a breaking change comment to the release notes when cutting the release?

davidgamero commented 1 year ago

Can we bump the version and add a breaking change comment to the release notes when cutting the release?

yes for sure! atm the flow is to have a dedicated release PR with the changelog entry, so I'll put it there