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

scripts/release-notes: new category "cluster virtualization". #106124

Merged
merged 1 commit into from
Jul 5, 2023

Conversation

knz
Copy link
Contributor

@knz knz commented Jul 4, 2023

Epic: CRDB-29380

The category cluster virtualization (aliased to multi-tenancy and virtualization) encompasses changes to our cluster virtualization and multi-tenancy infrastructure that have UX surfaces: SQL syntax, cluster settings, etc.

This includes changes only visible to SREs.

Release note: None

@knz knz requested a review from mikeCRL July 4, 2023 17:55
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@knz
Copy link
Contributor Author

knz commented Jul 4, 2023

NB I also have updated https://wiki.crdb.io/wiki/spaces/CRDB/pages/186548364/Release+notes already.

@knz knz added A-multitenancy Related to multi-tenancy backport-23.1.x Flags PRs that need to be backported to 23.1 labels Jul 4, 2023
Copy link
Contributor

@mikeCRL mikeCRL left a comment

Choose a reason for hiding this comment

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

Thank you! A few considerations I'd like to raise:

  1. We'd additionally discussed the idea of pushing these RNs to our new [future] doc page instead of the main release notes page. Alternatively, we could leave these RNs in place, and just add a one-line explanation under the heading, linking to our new page. Either way, that can be a follow-up decision and PR prior to the first alpha. FYI @amruss @lnhsingh.
  2. From the PR description, "This includes changes only visible to SREs" conflicts with this wiki section. Thoughts? (Is this intended as a temporary exception, or are we really doing that across the board, in practice, despite the wiki, and this is in keeping with that? Regardless I have plans to review RN content/policy soon. We can confirm and clarify what we want to say for this PR/wiki edit, and then revisit later.)
  3. Regarding release-notes.py, it looks like we are no longer using the one in the cockroach repo and are exclusively using the one we have in the ed-tools repo. I'll ask @nickvigilante to coordinate with you on getting these changes in the ed-tools copy and removing the original cockroach copy. Nick, note that the two latest commits affecting the file in cockroach came after you brought the file into ed-tools, so they should be revisited for potential inclusion. Can you please help with this?

Can we get additional Docs/PM approval before this change is made? Adding reviewers.

Copy link
Contributor

@nickvigilante nickvigilante left a comment

Choose a reason for hiding this comment

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

One issue, but LGTM otherwise!

scripts/release-notes.py Show resolved Hide resolved
@knz
Copy link
Contributor Author

knz commented Jul 5, 2023

  1. We'd additionally discussed the idea of pushing these RNs to our new [future] doc page instead of the main release notes page. Alternatively, we could leave these RNs in place, and just add a one-line explanation under the heading, linking to our new page. Either way, that can be a follow-up decision and PR prior to the first alpha. FYI @amruss @lnhsingh.

Agreed. One advantage I see of having the script scrape this new category is that it clumps all the related RNs together so we can more easily copy (or cut) them and paste them elsewhere.

  1. From the PR description, "This includes changes only visible to SREs" conflicts with this wiki section. Thoughts?

Yes the guidance is clear: if a product change applies only to an internal user group
The purpose here is that if a change only affects CC (internal to CRL) and only affects CRL staff then it doesn't deserve a release note.

But a change that affects SElf-hosted, and SREs for self-hosted cluster should get release notes. That's what the "ops change" category is for really (for non-multitenant stuff).

Can we get additional Docs/PM approval before this change is made? Adding reviewers.

Discussing this with Abbey today.

@knz
Copy link
Contributor Author

knz commented Jul 5, 2023

From the PR description, "This includes changes only visible to SREs" conflicts with this wiki section. Thoughts?

I took the liberty of updating the wiki page to clarify this.

@lnhsingh
Copy link
Contributor

lnhsingh commented Jul 5, 2023

This LGTM, with the assumption we'll decide where these release notes live in a future discussion.

@knz
Copy link
Contributor Author

knz commented Jul 5, 2023

Thanks. @nickvigilante what's your stance on this? You have a blocking review.

Copy link
Contributor

@nickvigilante nickvigilante left a comment

Choose a reason for hiding this comment

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

Approved with one change.

scripts/release-notes.py Show resolved Hide resolved
The category `cluster virtualization` (aliased to `multi-tenancy` and
`virtualization`) encompasses changes to our cluster virtualization
and multi-tenancy infrastructure that have UX surfaces: SQL syntax,
cluster settings, etc.

This includes changes only visible to SREs.

Release note: None
@knz
Copy link
Contributor Author

knz commented Jul 5, 2023

Cheers!

bors r=lnhsingh,nickvigilante

@craig
Copy link
Contributor

craig bot commented Jul 5, 2023

Build succeeded:

@craig craig bot merged commit f788417 into cockroachdb:master Jul 5, 2023
2 checks passed
@knz knz deleted the 20230704-release-notes branch July 6, 2023 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-multitenancy Related to multi-tenancy backport-23.1.x Flags PRs that need to be backported to 23.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants