Skip to content

[1.7.x] docs: fix wrong PR links and other mistakes in the release notes - #3603

Merged
pjfanning merged 1 commit into
apache:1.7.xfrom
pjfanning:docs-fix-release-notes-1.7
Oct 9, 2026
Merged

pjfanning merged 1 commit into
apache:1.7.xfrom
pjfanning:docs-fix-release-notes-1.7

Conversation

@pjfanning

Copy link
Copy Markdown
Member

Motivation

#3598 fixed wrong PR links and other mistakes in the release notes on main. The 1.x release notes pages on the 1.7.x branch have the same mistakes.

Modification

Cherry-pick of #3598 (git cherry-pick -x 1dd51690af) onto 1.7.x:

  • wrong PR numbers in the 1.0, 1.1, 1.2, 1.3 and 1.7 notes (PR1562, PR1480, PR1436, PR1468, PR2060, swapped PR2336/PR2337, PR1183, PR3169)
  • PR labels with issues/ URLs and vice versa (PR1743, PR1594, Cluster sharding delivers message to the wrong entity #1463)
  • 1.2.0 dependencies: slf4j spelling, junit-jupiter 5.13.4
  • version headings in the 1.2 to 1.7 pages are H2, missing 1.1.1 milestone link, named 1.2.1 milestone, Java support line on the 1.0.x page
  • typos

The only conflict was releases-2.0.md, which does not exist on 1.7.x; it is left out, so the 2.0.0-M* changes from #3598 are not part of this PR.

Result

The 1.x release notes on 1.7.x match main.

Tests

  • Not run - docs only

References

Refs #3598

…che#3598)

Motivation:
Checking every PR and issue reference in the release notes against
GitHub, and the dependency versions against the release tags, found
wrong PR numbers, mismatched labels and URLs, two wrong dependency
entries, inconsistent heading levels and some typos.

Modification:
- Wrong PR numbers:
  - 1.1.3 mixed Akka/Pekko cluster: PR1462 ("publish 1.0.3 docs") -> PR1562
  - 1.1.2 OSGi metadata: PR1464 (the sharding revert) -> PR1480
  - 1.1.0 virtual thread dispatcher: PR1299 (closed, not merged) -> PR1436
  - 1.2.0 StreamTestKit duration timeout: PR1648 -> PR1468
  - 1.2.0 CompletionStages helper: 2049 is the issue -> PR2060
  - 1.3.0 PR2336 and PR2337 were swapped
  - 1.0.3 TcpDnsClient: 1182 is the issue -> PR1183
  - 1.7.0 EndpointReader: apache#3169 is a PR, link it as one
- Fix PR labels with issues/ URLs and vice versa (PR1743, PR1594, apache#1463)
- 1.2.0 dependencies: slfj4 -> slf4j; jupiter-junit 5.13.3 ->
  junit-jupiter 5.13.4 (per the v1.2.0 tag)
- 2.0.0-M3: "Bug fix" -> "Bug Fixes" heading, "Var Handles" ->
  "VarHandles"
- Version headings in releases-1.2 to 1.7 are H2 like the 1.0, 1.1 and
  2.0 pages (they were H1, the same level as the page title)
- Add the missing 1.1.1 milestone link, name the 1.2.1 milestone, and
  add the Java support line to the 1.0.x page
- Typos: "This is a milestone release", "to get it to work", "it is
  likely", an unfinished sentence and a stray parenthesis in 1.0

Result:
Release note links point to the right PRs and issues, and the pages are
consistent.

Tests:
- Not run - docs only

References:
None - found during a review of the release notes

(cherry picked from commit 1dd5169)
@pjfanning
pjfanning merged commit a5d2d06 into apache:1.7.x Oct 9, 2026
10 checks passed
@pjfanning
pjfanning deleted the docs-fix-release-notes-1.7 branch October 9, 2026 10:24
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