Skip to content

Conversation

@wking
Copy link
Member

@wking wking commented Aug 1, 2022

The lowercase form just landed via 9db3a0c (#1232), CC @raspbeep, and that matched the lower-case precedent which we had been using for these enumerated capabilities. But the Kube-API preference is for PascalCase, so this commit pivots to that form. Because we are so close on the heels of the original change, we don't need to preserve any references to the outgoing form. Adjusting the 4.11 references like openshift-samples will take more dancing, and can happen in follow-up
work. Generated with:

$ sed -i 's|\(capability[.]openshift[.]io/name\): console|\1: Console|' $(git grep -l 'capability.openshift.io/name: console')
$ sed -i 's/console/Console/' config/v1/*version*

And then backing out one godocs hit that the above made:

$ sed -i 's/the web Console/the web console/' config/v1/*version*

The lowercase form just landed via 9db3a0c (CONSOLE-3221: Add
console capability (openshift#1232), 2022-08-01), and that matched the
lower-case precedent which we had been using for these enumerated
capabilities.  But the Kube-API preference is for PascalCase [1], so
this commit pivots to that form.  Because we are so close on the heels
of the original change, we don't need to preserve any references to
the outgoing form.  Adjusting the 4.11 references like
openshift-samples will take more dancing, and can happen in follow-up
work.

Generated with:

  $ sed -i 's|\(capability[.]openshift[.]io/name\): console|\1: Console|' $(git grep -l 'capability.openshift.io/name: console')
  $ sed -i 's/console/Console/' config/v1/*version*

And then backing out one godocs hit that the above made:

  $ sed -i 's/the web Console/the web console/' config/v1/*version*

[1]: https://github.com/openshift/enhancements/blame/b3f5408be4505e37c0bdb7f8b2630a92a5d01457/dev-guide/api-conventions.md#L195
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2022

Hello @wking! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

For merging purposes, this repository follows the no-Feature-Freeze process which means that in addition to the standard lgtm and approved labels this repository requires either:

bugzilla/valid-bug - applied if your PR references a valid bugzilla bug

OR

qe-approved, docs-approved, and px-approved - these labels can be applied by anyone in the openshift org via the /label command.

Who should apply these qe/docs/px labels?

  • For a no-Feature-Freeze team who is merging a feature before code freeze, they need to get those labels applied to their api repo PR by the appropriate teams (i.e. qe, docs, px)
  • For a Feature Freeze (traditional) team who is merging a feature before FF, they can self-apply the labels (via /label commands), they are basically irrelevant for those teams
  • For a Feature Freeze team who is merging a feature after FF, the PR should be rejected barring an exception

@openshift-ci openshift-ci bot requested review from adambkaplan and spadgett August 1, 2022 18:21
@deads2k
Copy link
Contributor

deads2k commented Aug 1, 2022

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deads2k, wking

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

The pull request process is described here

Details 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 openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 1, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2022

@wking: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@deads2k deads2k added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Aug 2, 2022
@openshift-merge-robot openshift-merge-robot merged commit 875099a into openshift:master Aug 2, 2022
@wking wking deleted the console-enum-pascal-case branch August 2, 2022 15:04
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. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants