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

Release notes for operator-sdk version upgrade epic #2323

Closed
wants to merge 1 commit into from

Conversation

Jaanki
Copy link
Contributor

@Jaanki Jaanki commented Nov 3, 2022

submariner-io/enhancements#81

Signed-off-by: Janki Chhatbar [email protected]

@submariner-bot
Copy link
Contributor

🤖 Created branch: z_pr2323/Jaanki/sdk_upgrade_rn
🚀 Full E2E won't run until the "ready-to-test" label is applied. I will add it automatically once the PR has 2 approvals, or you can add it manually.

@Jaanki Jaanki changed the title Release notes for Release notes for operator-sdk version upgrade epic Nov 3, 2022
Copy link
Member

@skitt skitt left a comment

Choose a reason for hiding this comment

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

I thought we’d said the Operator SDK changes didn’t need release notes, since they’re not user-visible. Has that changed?

@Jaanki
Copy link
Contributor Author

Jaanki commented Nov 3, 2022

I wasn't aware of this decision. Anyways, I think the path change for APIs should be mentioned. It could be used by other projects.

@Jaanki Jaanki requested a review from skitt November 3, 2022 09:54
Comment on lines 2 to 3
* operator-sdk version is upgraded to 1.23.0.
* Submariner-operator APIs are converted to single-group. Meaning, API definitions can now be found under `api/`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* operator-sdk version is upgraded to 1.23.0.
* Submariner-operator APIs are converted to single-group. Meaning, API definitions can now be found under `api/`.
* The project was rebuilt using Operator SDK version 1.23.0.
* The operator APIs have been converted to single-group; projects depending on these will need to
replace `github.com/submariner-io/submariner-operator/api/submariner/v1alpha1` with
`github.com/submariner-io/submariner-operator/api/v1alpha1` in their imports.

@tpantelis
Copy link
Contributor

tpantelis commented Nov 3, 2022

I wasn't aware of this decision. Anyways, I think the path change for APIs should be mentioned. It could be used by other projects.

Fair enough, let’s describe the impact explicitly.

Also discussing this on slack. We've stated and agreed in the past that RNs are for end users. A Go API change is not for end users. We've many Go API changes in the past sans RN. Let's stay consistent.

@tpantelis
Copy link
Contributor

Also discussing this on slack. We've stated and agreed in the past that RNs are for end users. A Go API change is not for end users. We've many Go API changes in the past sans RN. Let's stay consistent.

As a follow-up, to notify possible users of the submariner-operator project of the API change, we could add a note to the project release tag once that's created.

@tpantelis tpantelis closed this Nov 4, 2022
@submariner-bot
Copy link
Contributor

🤖 Closed branches: [z_pr2323/Jaanki/sdk_upgrade_rn]

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.

4 participants