-
Notifications
You must be signed in to change notification settings - Fork 565
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
Remove non link brackets from release notes #5737
base: main
Are you sure you want to change the base?
Conversation
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. |
Size Report 1Affected ProductsNo changes between base commit (2865f2b) and merge commit (e77deca).Test Logs |
Coverage Report 1Affected Products
Test Logs |
* | ||
* @see [Change.toReleaseNote] | ||
*/ | ||
private val NON_LINK_BRACKETS_REGEX = Regex("\\[(.+?)](?!\\()", RegexOption.MULTILINE) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This regex will match [foo](bar.baz) lorem ipsum [qud]
and could be adjusted to not match ]
characters outside of the terminating one.
In (most)? cases, what we want is the reference to be transformed from [app_check] to {{app_check}}, see https://github.com/firebase/firebase-android-sdk/blob/master/appcheck/firebase-appcheck-debug/CHANGELOG.md and cl/605317607 rather than removed |
@rachelsaunders does tooling break or complains if an unknown value is present inside the double brackets? e.g. {{notaname}}, does it complain/break or silently drops it? |
If the contents within the double curly braces is not a valid string, our internal staging/build tooling will error (and maybe even break the build). It won't just silently drop it. So, if the string happens to be wrong here in the changelog and thus the conversion into the internal systems, we'll be able to easily catch it downstream before it goes to prod. |
That's what I was hoping for, thanks! |
Per b/326629027,
This adds a transformation in our release notes to separate brackets from their content if they're not wrapping a link. This is to avoid propagating the content to the release notes, as it shouldn't be there. In the future, we may want to add some warning for instances found (as they may have been intended to be links).