fix: tolerate <details> blocks without a summary when re-parsing release pull request bodies - #2885
Open
johnitvn wants to merge 1 commit into
Open
Conversation
…ase pull request bodies
Commit subjects can legitimately contain tokens like `<details>` inside
inline code spans, and htmlEscape intentionally leaves those untouched.
When such a body is later re-parsed by extractMultipleReleases, the HTML
parser sees a real <details> element that has no <summary>, and the code
dereferenced it unconditionally, crashing with:
TypeError: Cannot read properties of undefined (reading 'match')
This blocks every subsequent release-please run until the pull request
is merged or its body is edited by hand.
Skip summary-less details blocks with a warning so parsing falls back to
the single-release path, and valid components around such blocks keep
parsing as before.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Author
|
I have already signed the CLA. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #2884 🦕
Problem
extractMultipleReleases()re-parses release pull request bodies withnode-html-parser. A commit subject may legitimately contain a token like`<details>`inside an inline code span (whichhtmlEscape()intentionally leaves untouched, see #2801). The HTML parser does not understand markdown, so that token becomes a real<details>element without a<summary>child, and the current code dereferences it unconditionally:This hard-crashes every subsequent
release-pleaserun (Cannot read properties of undefined (reading 'match')) until someone merges or manually edits the open release pull request. Reproduction and full stack trace in #2884; observed in the wild on 17.6.0 and verified still present in 17.11.1.Fix
Skip
<details>blocks that have no<summary>, with a warning:Generated blocks always carry a
<summary>, so real multi-component parsing is unchanged. For single-package bodies containing such a stray token, extraction now correctly falls back to the existing single-release path instead of throwing.Tests
should tolerate a <details> element missing a <summary>- a body whose changelog bullet contains a backticked<details>token parses to one release via the fallback path (previously crashed with exactly the reportedTypeError)should keep parsing valid components around a <details> element missing a <summary>- injecting a stray summary-less block into the multi-component fixture still yields all valid componentsgts checkclean, coverage not decreased