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-23.2: ui: use versioned crdb-protobuf-client #129352

Merged
merged 1 commit into from
Aug 21, 2024

Conversation

dhartunian
Copy link
Collaborator

@dhartunian dhartunian commented Aug 20, 2024

Previously cluster-ui was using a workspace link to the protobuf client that linked directly to the src/js directory in the db- console workspace that contained this library.

This made it difficult to import cluster-ui elsewhere as it wouldn't be able to find that dependency outside this project structure.

We've separately published a 24.2.1 version of the protobuf library which will enable it to be used outside of this repo.

Release note: None


Release justification: non-user-facing change to support cluster-ui lib

Previously `cluster-ui` was using a workspace link to the protobuf
client that linked directly to the `src/js` directory in the `db-
console` workspace that contained this library.

This made it difficult to import `cluster-ui` elsewhere as it wouldn't
be able to find that dependency outside this project structure.

We've separately published a 24.2.1 version of the protobuf library
which will enable it to be used outside of this repo.

Release note: None
@dhartunian dhartunian requested a review from a team as a code owner August 20, 2024 19:50
@dhartunian dhartunian requested review from kyle-a-wong and removed request for a team August 20, 2024 19:50
Copy link

blathers-crl bot commented Aug 20, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Aug 20, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Contributor

@laurenbarker laurenbarker left a comment

Choose a reason for hiding this comment

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

Do you foresee any issues with the client 24.2 being set to a specific version of the protobufs? I imagine it would only be an issue for backports, but I'm not super familiar with how many backports impact protos.

@dhartunian
Copy link
Collaborator Author

@laurenbarker I think CRDB builds should be fine because typically the protos don't change in backports, and even if they did, the lockfile still references the local version (specifier has changed, but not the version), not the published file so the only drift would be if published a new version of cluster-ui that referenced an older client.

@dhartunian dhartunian added this pull request to the merge queue Aug 20, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Aug 20, 2024
@dhartunian dhartunian merged commit 42bdfb1 into cockroachdb:release-24.2 Aug 21, 2024
18 of 20 checks passed
@dhartunian dhartunian deleted the cluster-ui-24.2.1 branch August 21, 2024 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants