32.0 -> 32.1.
Add some missing PR #s (needed if #36769 happens more).
doc: fix up some release notes #36773
pull fanquake wants to merge 2 commits into bitcoin:master from fanquake:fixup_relnotes changing 21 files +69 −44-
fanquake commented at 11:58 AM on November 5, 2026: member
- DrahtBot added the label Docs on Nov 5, 2026
-
DrahtBot commented at 11:58 AM on November 5, 2026: contributor
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
External sites
- Code coverage & benchmarks: https://corecheck.dev/bitcoin/bitcoin/pulls/36773
- Ralph review <img src=https://review.fish.foo/assets/bitcoin/bitcoin/36773.png alt="Ralph review status"> https://git.fish.foo/bitcoin/bitcoin/pulls/36773#author-ralph
<!--021abf342d371248e50ceaed478a90ca-->
Reviews
See the guideline and AI policy for information on the review process. A summary of reviews will appear here.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
-
fanquake commented at 3:20 PM on November 5, 2026: member
If we want the pull numbers in the text,
I think we do, because bitcoincore.org is setup to automatically generate links to each PR, from the release notes, i.e https://bitcoincore.org/en/releases/32.1/.
- fanquake force-pushed on Nov 5, 2026
-
maflcko commented at 5:48 PM on November 5, 2026: member
<details><summary>I guess something like this should lint it, if needed</summary>
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 7e1e616..9120d60 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1302,2 +1302,4 @@ Release notes should be added to a uniquely named release note file, such as `/doc/release-notes-remove-feature-foo.md`, to avoid conflicts between multiple PRs. +Include the pull request number in the snippet, using `(#12345)` for a +bitcoin/bitcoin PR or `(gui#123)` for a bitcoin-core/gui PR. All `release-notes*` files are merged into a single `release-notes-<version>.md` file prior to the release. diff --git a/test/lint/test_runner/src/lint_docs.rs b/test/lint/test_runner/src/lint_docs.rs index 9d53af2..cf328f7 100644 --- a/test/lint/test_runner/src/lint_docs.rs +++ b/test/lint/test_runner/src/lint_docs.rs @@ -4,2 +4,3 @@ +use std::fs; use std::io::ErrorKind; @@ -16,7 +17,5 @@ pub fn lint_doc_release_note_snippets() -> LintResult { ]))?; - if non_release_notes.is_empty() { - Ok(()) - } else { + if !non_release_notes.is_empty() { println!("{non_release_notes}"); - Err(r#" + return Err(r#" Release note snippets and other docs must be put into the doc/ folder directly. @@ -27,4 +26,25 @@ be uniquely named and placed directly in the doc/ folder. .trim() - .to_string()) + .to_string()); + } + + let snippets = check_output(git().args([ + "ls-files", + "--", + ":(glob)doc/release-notes-*.md", + ":(exclude)doc/release-notes-empty-template.md", + ]))?; + let mut missing = Vec::new(); + for path in snippets.lines() { + let note = fs::read_to_string(path).expect("must be able to read release note snippet"); + if !note.contains("(#") && !note.contains("(gui#") { + missing.push(path); + } + } + if !missing.is_empty() { + return Err(format!( + "Release note snippets must mention their PR as (#12345) or (gui#123):\n{}", + missing.join("\n") + )); } + Ok(()) } diff --git a/test/lint/test_runner/src/main.rs b/test/lint/test_runner/src/main.rs index 7c0eb58..9f7aecd 100644 --- a/test/lint/test_runner/src/main.rs +++ b/test/lint/test_runner/src/main.rs @@ -81,3 +81,3 @@ fn get_linter_list() -> Vec<&'static Linter> { &Linter { - description: "Check that release note snippets are in the right folder", + description: "Check the location and PR references of release note snippets", name: "doc_release_note_snippets",</details>
-
aaef323bd6
doc: fix up some release notes
32.0 -> 32.1. Add some missing PR #s (needed if #36769 happens more).
-
fdfcf5c63c
lint: check release note snippets reference their PR
Co-authored-by: MarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz> - fanquake force-pushed on Nov 6, 2026
Labels