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

⚠️ Rework naming of references in the API #92

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

dtantsur
Copy link
Member

As discussed in
#91, lets
use simpler reference names and reserve the SomethingRef format for when
the field can refer to different kinds or at least namespaces.

This is quite a breaking change but I don't see a lot of value in going
through deprecation since it's going to significantly complicate the
code nobody should be using in production yet.

Closes: #91
Signed-off-by: Dmitry Tantsur dtantsur@protonmail.com

@metal3-io-bot metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 28, 2024
@dtantsur
Copy link
Member Author

/hold

I'll create a corresponding metal3-dev-env change.

@metal3-io-bot metal3-io-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 28, 2024
@dtantsur
Copy link
Member Author

metal3-io/metal3-dev-env#1478 pins IrSO to avoid breaking metal3-dev-env with this.

@dtantsur dtantsur added this to the IrSO MVP milestone Nov 29, 2024
@dtantsur
Copy link
Member Author

/hold cancel

@metal3-io-bot metal3-io-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 29, 2024
@tuminoid
Copy link
Member

tuminoid commented Dec 2, 2024

This is quite a breaking change but I don't see a lot of value in going through deprecation since it's going to significantly complicate the code nobody should be using in production yet.

We absolutely should not make life difficult for ourselves here, this is pre-MVP.

Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

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

Looks much cleaner to me.

/approve

@metal3-io-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tuminoid

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

@metal3-io-bot metal3-io-bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-rebase Indicates that a PR cannot be merged because it has merge conflicts with HEAD. labels Dec 2, 2024
As discussed in
metal3-io#91, lets
use simpler reference names and reserve the SomethingRef format for when
the field can refer to different kinds or at least namespaces.

This is quite a breaking change but I don't see a lot of value in going
through deprecation since it's going to significantly complicate the
code nobody should be using in production yet.

Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
@metal3-io-bot metal3-io-bot removed the needs-rebase Indicates that a PR cannot be merged because it has merge conflicts with HEAD. label Dec 2, 2024
@elfosardo
Copy link
Member

best do a change like this now

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 3, 2024
@metal3-io-bot metal3-io-bot merged commit 92acffd into metal3-io:main Dec 3, 2024
10 checks passed
@dtantsur dtantsur deleted the api-naming branch December 3, 2024 13:19
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. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Settle down on the naming condition: somethingRef vs somethingName
4 participants