Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename helm imageKey to image to match starter workflows #176

Merged

Conversation

davidgamero
Copy link
Collaborator

@davidgamero davidgamero commented Feb 2, 2023

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

  • Breaking Change - new variable IMAGETAG and changed usage of IMAGENAME
  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

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).

  • existing integration tests pass

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@davidgamero davidgamero changed the title rename imageKey to image to match starter workflows rename helm imageKey to image to match starter workflows Feb 9, 2023
@sabbour
Copy link
Collaborator

sabbour commented Feb 9, 2023

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

@davidgamero
Copy link
Collaborator Author

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

Copy link
Member

@bfoley13 bfoley13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@OliverMKing OliverMKing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@davidgamero davidgamero merged commit e8455c8 into Azure:main Feb 10, 2023
@davidgamero davidgamero mentioned this pull request Feb 13, 2023
aamgayle pushed a commit to aamgayle/draft that referenced this pull request Mar 23, 2023
@davidgamero davidgamero deleted the davidgamero/helm-match-starter-workflows branch April 18, 2023 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants