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.1: docgen: update BEGIN and SET TRANSACTION diagrams without iso level #137371

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

taroface
Copy link
Collaborator

Backport 1/1 commits from #137368.

/cc @cockroachdb/release


Updated the BEGIN diagram for v23.1, which had been empty since this commit. (#137058 covers v23.2 and later.)

image

Also updated the SET TRANSACTION diagram, which had not been displaying most of its syntax.

image

Epic: none
Release note: none
Release justification: non-production code change

Copy link

blathers-crl bot commented Dec 13, 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 Dec 13, 2024
Copy link

blathers-crl bot commented Dec 13, 2024

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Member

@yuzefovich yuzefovich left a comment

Choose a reason for hiding this comment

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

LGTM, but curious about the need for backports to 23.1 and 22.2 branches - I think we might not have any more scheduled releases on them, what's the reason for backporting this change? Are the docs pages for the corresponding release somehow influenced by this?

Reviewed 10 of 10 files at r1, all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @taroface)

@taroface
Copy link
Collaborator Author

taroface commented Dec 13, 2024

TFTR! Yes, this is strictly to fix some broken diagrams (technically generating new HTML files in generated-diagrams repo) so that they will appear properly on the docs pages for the corresponding version. The BEGIN diagram being broken since 22.2 was identified as an issue.

@taroface taroface merged commit 6db4ddd into cockroachdb:release-23.1 Dec 16, 2024
6 checks passed
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