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

Unify Go struct field names with YAML/JSON field names #687

Merged
merged 1 commit into from
Mar 24, 2021

Conversation

imjasonh
Copy link
Contributor

@imjasonh imjasonh commented Mar 22, 2021

Changes

  • The GitSource type is renamed to Source and moved to source.go
  • The StrategyRef type is renamed to Strategy
  • The StrategyRef field is renamed to Strategy
  • The BuilderImage field is renamed to Builder
  • The ImageURL field is renamed to Image
  • SecretRef fields in various places are renamed to Credentials
  • Some small godoc comment improvements

This is not intended to be a breaking API change for YAML/JSON users (incl objects stored in etcd). This will require updates to clients using generated Go clients to interact with the API, but these changes should be minimal

#516

/kind cleanup

Submitter Checklist

  • [n/a] Includes tests if functionality changed/was added
  • [n/a] Includes docs if changes are user-facing
  • [y] Set a kind label on this PR
  • [y] Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

Update Go type and field names; no user-visible changes expected.

Existing code to interact with the API is expected to work. When updating to new versions of the generated Go client, code will need to change to reference new field names.

@openshift-ci-robot openshift-ci-robot added release-note Label for when a PR has specified a release note kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Mar 22, 2021
@openshift-ci-robot openshift-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 22, 2021
@imjasonh imjasonh changed the title Unify Unify Go struct field names with YAML/JSON field names Mar 22, 2021
@openshift-ci-robot openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 22, 2021
@imjasonh imjasonh force-pushed the unify branch 4 times, most recently from eeeec4d to 40f225a Compare March 22, 2021 16:35
@adambkaplan adambkaplan mentioned this pull request Mar 22, 2021
4 tasks
@qu1queee qu1queee self-requested a review March 23, 2021 09:26
@qu1queee
Copy link
Contributor

@imjasonh can we enhance the Release Notes to include something like:

Update Go type and field names; no user-visible changes expected. This is a breaking change that require updates to clients using generated Go clients to interact with the API

I think this will affect some internal tooling we have, build-load and shipwright cli, therefore the ask.

@imjasonh
Copy link
Contributor Author

Updated the release notes to reflect that code will need to be updated, but existing client versions should still work in the meantime.

Copy link
Contributor

@qu1queee qu1queee left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 23, 2021
@qu1queee
Copy link
Contributor

/approve

@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qu1queee

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 24, 2021
@openshift-merge-robot openshift-merge-robot merged commit 6fb0218 into shipwright-io:master Mar 24, 2021
@qu1queee qu1queee added this to the release-v0.4.0 milestone Mar 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note Label for when a PR has specified a release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants