Skip to content

DOC-17055: Remove cockroach PR/commit links from release notes#23301

Open
ebembi-crdb wants to merge 4 commits into
mainfrom
unlink-release-notes
Open

DOC-17055: Remove cockroach PR/commit links from release notes#23301
ebembi-crdb wants to merge 4 commits into
mainfrom
unlink-release-notes

Conversation

@ebembi-crdb
Copy link
Copy Markdown
Contributor

Summary

  • Unlinks 287 release note files by converting [#85177][#85177] to plain #85177 text
  • Removes markdown reference-style links pointing to PRs and commits in the cockroach repo
  • Release note content is preserved; only the hyperlinks are removed

This is PR 1 of 10 splitting #23256 into reviewable chunks.

Jira: DOC-17055

Test plan

  • Verify PR/commit numbers still display correctly as plain text
  • Run local Jekyll build and check a sample of release note pages
  • Confirm no remaining [#NNNNN][#NNNNN] patterns in release note includes

🤖 Generated with Claude Code

Unlink 287 release note files by converting markdown references like
[#85177][#85177] to plain #85177 text. These links pointed to PRs and
commits in the cockroach repo that are not useful references for users
reading release notes.

Part of DOC-17055.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 698e7aa
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/6a05b16be0a6bc0008549fea

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 698e7aa
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/6a05b16b1fe2120008646981

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Netlify Preview

Name Link
🔨 Latest commit 698e7aa
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/6a05b16b43ee520008c2b56a
😎 Deploy Preview https://deploy-preview-23301--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Resolve conflicts in v26.2 release note files where main added new
entries. Keep main's content with PR links stripped per this branch's
purpose.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

Files changed:

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 13, 2026

Cross-Version Link Check Passed

All cross-version link issues have been resolved. Good job!

ebembi-crdb and others added 2 commits May 13, 2026 21:52
Replace hardcoded version paths with {{ page.version.version }} in
10 release note files to fix CI cross-version link check.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Release note includes don't have page.version.version available.
Revert cross-version links to use each file's own version instead.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Added a new session variable `allow_role_memberships_to_change_during_transaction` which can be used to make the [granting]({% link v23.1/grant.md %}) and [revoking]({% link v23.1/revoke.md %}) of [role memberships](https://www.cockroachlabs.com/docs/v23.1/security-reference/authorization#roles) faster at the cost of some [isolation](https://www.cockroachlabs.com/docs/v23.1/architecture/transaction-layer#isolation-levels) claims. By default, when granting or revoking a role from another role, CockroachDB waits for all [transactions]({% link v23.1/transactions.md %}) that are consulting the current set of role memberships to complete. This means that by the time the transaction which performed the grant or revoke operation returns successfully, the user has a proof that no ongoing transaction is relying on the state that existed prior to the change. The downside of this waiting is that it means that `GRANT` and `REVOKE` will take longer than the longest currently executing transaction. In some cases, users do not care about whether concurrent transactions will immediately see the side-effects of the operation, and would instead prefer that the grant or revoke finish rapidly. In order to aid in those cases, the session variable `allow_role_memberships_to_change_during_transaction` has been added. Now, the grant or revoke will only need to wait for the completion of statements in [sessions]({% link v23.1/show-sessions.md %}) which do not have this option set. One can set the option as enabled by default in all sessions in order to accelerate and grant and revoke role operations. [#98370][#98370]
- Fixed a bug where CockroachDB panicked when a user tried to [truncate a table]({% link v23.1/truncate.md %}) which had an ongoing [Row-level TTL]({% link v23.1/row-level-ttl.md %}) change. CockroachDB still does not support truncating a table in this scenario, but instead of panicking an "unimplemented" error is returned. [#98537][#98537]
- A regions field was added to the `statistics` column of [`crdb_internal.statement_statistics`](https://www.cockroachlabs.com/docs/v23.1/crdb-internal#statement_statistics), reporting the [regions]({% link v23.1/show-regions.md %}) of the nodes on which the statement was executed. #95449
- The `enforce_home_region` [session setting]({% link v23.1/set-vars.md %}#enforce-home-region) was extended with a new optional preview feature and session setting, which is disabled by default, to dynamically detect and report the home region for [`SELECT`]({% link v23.1/selection-queries.md %}) queries based on the [locality]({% link v23.1/show-locality.md %}) of the queried rows, if different from the region of the [gateway node]({% link v23.1/ui-sessions-page.md %}#session-details-gateway-node). [cockroachdb/cockroach#97827]#97827
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

there are several instances of malformed links like this one: [cockroachdb/cockroach#97827]#97827 - please fix this and the others (should be a mechanical regex over the PR)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

here are the other instances found by Codex in this PR for reference:

  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:27 - #97827
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:33 - #98217
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:45 - #98543
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:68 - #98312
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:71 - #97138
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:79 - #97948
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:82 - #98307
  • src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md:99 - #98261
  • src/current/_includes/releases/v23.2/v23.2.12.md:26 - #130712
  • src/current/_includes/releases/v23.2/v23.2.12.md:37 - #128864
  • src/current/_includes/releases/v24.1/v24.1.2.md:20 - #125554
  • src/current/_includes/releases/v24.2/v24.2.0-beta.2.md:28 - #127364

- Fixed a bug where [changefeeds]({% link v23.1/change-data-capture-overview.md %}) would fail when upgrading to version [v23.1.5](#v23-1-5) because the job record did not have a `clusterID` field set. #106399
- Fixed a bug where `UPDATE`, `UPSERT`, `DELETE` statements running concurrently with [`ALTER TABLE..ADD COLUMN`]({% link v23.1/alter-table.md %}#add-column) of a virtual computed column on the same table would fail. #107403
- Fixed a bug where [SQL statistics compaction jobs]({% link v23.1/show-jobs.md %}#show-automatic-jobs) would fail. This is now fixed by reducing the contention on the `system.statement_statistics` table. #107573
- Fixed a bug where running a [changefeed]({% link v23.1/change-data-capture-overview.md %}) that targets a table with a user-defined type column and with the [`envelope` option]({% link v23.1/create-changefeed.md %}#envelope) set to any value other than `wrapped` would cause a node panic due to a nil dereference. [#119746][119746]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this still uses the old [#xxx][#xxx] format - please update so it's plain text #xxx like the other PR IDs

Copy link
Copy Markdown
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

LGTM once you fix the few link formatting issues i mentioned! thanks @ebembi-crdb !

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.

2 participants