Repository navigation
Keep $ in the tag message intact in the package release notes - #42
Merged
Merged
Conversation
The release workflow writes the annotated tag message into the .vipb's <Release_Notes> with -replace. The message was used as the replacement text, so .NET read $_, $&, $` and $' in it as substitutions: a tag message containing "$_" put the whole .vipb line into the package's release notes. SecurityElement.Escape does not touch $. Every $ is now doubled before the replacement, so the notes in the package match the tag message. The GitHub release text was never affected; it is written from the message directly. This changes the template only. The live .github/workflows/release.yml needs the same one-line edit by the maintainer. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Tests✅ All 64 tests passed. Per-test results
Protocol tests✅ Protocol tester output (0 failed required checks)VI diff reportNo VI, VIM or CTL files changed in this pull request. Report for commit 6c66954. The installable test package is under Artifacts of this run once the build job has finished. |
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.
Summary
The release workflow writes the annotated tag message into the
.vipb's<Release_Notes>with-replace, using the message as the replacement text. .NET reads$_,$&,$`and$'in it as substitutions, so a tag message containing$_put a whole.vipbline into the package's release notes. This doubles every$first. The GitHub release text was never affected.<Release_Notes>beforeCosts $_ and $&Costs <Release_Notes>old</Release_Notes> and <Release_Notes>old</Release_Notes>Costs $_ and $&Changes
tools/ci/release.workflow.yml(modified): step 4 escapes$as$$before the replacement, with a comment saying why.Verified
src/LabVIEW MCP Server SDK.vipbwith a multi-line message containing$_,$&,$1,<tags>and&. The file is still valid XML and<Release_Notes>reads back exactly as the message.Not verified
Known rough edges
None.
Maintainer steps
Apply the same edit to the live
.github/workflows/release.yml, step "4. Inject the Release Notes into the VIPB". Replacewith
After that the template and the live file are identical again (apart from CRLF). Until then, keep
$out of tag messages.🤖 Generated with Claude Code