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.

Sign up for GitHub

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

Jump to bottom

add section about adding new APIs #1815

Merged
merged 1 commit into from Mar 19, 2024
Merged

add section about adding new APIs #1815

merged 1 commit into from Mar 19, 2024

Conversation

deads2k
Copy link
Contributor

@deads2k deads2k commented Mar 15, 2024

I got this far before needing to get dressed for the Daddy Daughter Dance.

/hold
/assign @JoelSpeed

@openshift-ci openshift-ci bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Mar 15, 2024
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Mar 15, 2024

Hello @deads2k! 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.

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 15, 2024
@openshift-ci openshift-ci bot requested review from knobunc and mfojtik March 15, 2024 20:45
@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 15, 2024
JoelSpeed
JoelSpeed reviewed Mar 18, 2024
View reviewed changes
README.md Outdated
// spec is the desired state of the cluster version - the operator will work
// to ensure that the desired version is applied to the cluster.
// +kubebuilder:validation:Required
// +required
Copy link
Contributor

Choose a reason for hiding this comment

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

Drop this one, trying to push towards just using the full kubebuilder version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Drop this one, trying to push towards just using the full kubebuilder version

any idea whether we still have a generator using it for anything?

Copy link
Contributor

Choose a reason for hiding this comment

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

To my knowledge, we don't have any generators using the un-prefixed tag

@jan--f jan--f mentioned this pull request Mar 18, 2024
Merged
1 task
@deads2k deads2k changed the title [wip] add section about adding new APIs add section about adding new APIs Mar 18, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 18, 2024
@deads2k deads2k added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Mar 18, 2024
@deads2k
Copy link
Contributor Author

deads2k commented Mar 18, 2024

/retest

theobarberbany
theobarberbany reviewed Mar 18, 2024
View reviewed changes
README.md Outdated
@@ -3,13 +3,146 @@ The canonical location of the OpenShift API definition.
This repo holds the API type definitions and serialization code used by [openshift/client-go](https://github.com/openshift/client-go)
APIs in this repo ship inside OCP payloads.

## Adding new FeatureGates
Add your FeatureGate to feature_gates.go.
The threshold for merging a fully disabled or TechPreview FeatureGAte is an open enhancement.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The threshold for merging a fully disabled or TechPreview FeatureGAte is an open enhancement.
The threshold for merging a fully disabled or TechPreview FeatureGate is an open enhancement.

@JoelSpeed
Copy link
Contributor

Apart from the typo Theo found, LGTM

@deads2k
Copy link
Contributor Author

deads2k commented Mar 19, 2024

Updated

@JoelSpeed
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 19, 2024
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Mar 19, 2024

[APPROVALNOTIFIER] This PR is APPROVED

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

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
Copy link

/retest-required

Remaining retests: 0 against base HEAD 8ebde95 and 2 for PR HEAD 97584ca in total

@deads2k
Copy link
Contributor Author

deads2k commented Mar 19, 2024

/retest

jan--f
jan--f reviewed Mar 19, 2024
View reviewed changes
README.md
@@ -3,13 +3,146 @@ The canonical location of the OpenShift API definition.
This repo holds the API type definitions and serialization code used by [openshift/client-go](https://github.com/openshift/client-go)
APIs in this repo ship inside OCP payloads.

## Adding new FeatureGates
Add your FeatureGate to feature_gates.go.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Add your FeatureGate to feature_gates.go.
Add your FeatureGate to config/v1/feature_gates.go.

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Mar 19, 2024

@deads2k: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-upgrade-minor 97584ca link true /test e2e-upgrade-minor

Full PR test history. Your PR dashboard.

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 merged commit 06c557c into openshift:master Mar 19, 2024
8 of 10 checks passed
@openshift-bot
Copy link

[ART PR BUILD NOTIFIER]

This PR has been included in build ose-cluster-config-api-container-v4.16.0-202403191814.p0.g06c557c.assembly.stream.el9 for distgit ose-cluster-config-api.
All builds following this will include this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jan--f jan--f jan--f left review comments

@JoelSpeed JoelSpeed JoelSpeed left review comments

@theobarberbany theobarberbany theobarberbany left review comments

@knobunc knobunc Awaiting requested review from knobunc

@mfojtik mfojtik Awaiting requested review from mfojtik

Assignees

@JoelSpeed JoelSpeed

Labels
acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@deads2k @JoelSpeed @openshift-ci-robot @openshift-bot @jan--f @theobarberbany