fix(mcms/analyzer/renderer): inline complex parameter values in markdown for new proposal analysis framework by graham-chainlink · Pull Request #858 · smartcontractkit/chainlink-deployments-framework

graham-chainlink · 2026-03-16T03:22:08Z

Render multiline parameter values as indented text blocks within input bullets and expand golden test coverage.

Currently:

Should be similar to the legacy behaviour:

changeset-bot · 2026-03-16T03:22:14Z

🦋 Changeset detected

Latest commit: 319e513

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
chainlink-deployments-framework	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copilot

Pull request overview

Updates the MCMS proposal analysis markdown renderer to display multiline/complex parameter values as indented fenced blocks (closer to legacy output), and expands the golden fixtures to cover the new formatting.

Changes:

Render parameters whose formatted value contains newlines as indented fenced text blocks in markdown.
Add template helper functions to detect multiline params and indent block content.
Extend the markdown golden test/fixture with complex parameter examples and add a changeset entry.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl	Adds conditional block rendering for multiline parameter values.
engine/cld/mcms/proposalanalysis/renderer/funcmap.go	Adds `paramNeedsBlock` and `indentLines` helpers to support block rendering.
engine/cld/mcms/proposalanalysis/renderer/golden_test.go	Expands the golden proposal test data with complex params to exercise new rendering.
engine/cld/mcms/proposalanalysis/renderer/testdata/golden_markdown.md	Updates expected markdown output to include fenced blocks for multiline params.
.changeset/five-colts-yawn.md	Adds a patch changeset entry for the markdown formatting fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

engine/cld/mcms/proposalanalysis/renderer/funcmap.go

engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl

engine/cld/mcms/proposalanalysis/renderer/funcmap.go

engine/cld/mcms/proposalanalysis/renderer/golden_test.go

.changeset/five-colts-yawn.md

Copilot

Pull request overview

Updates the proposal analysis Markdown renderer to display complex/multiline parameter values inline as indented fenced blocks (matching legacy rendering), and extends the golden fixture/test to cover these cases.

Changes:

Render multiline parameter values as indented ```text blocks under the parameter bullet.
Add template helpers (hasNewline, indentLines) to support the new Markdown formatting.
Expand golden test data to include bytes and structured/multiline inputs, plus a changeset entry.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
engine/cld/mcms/proposalanalysis/renderer/testdata/golden_markdown.md	Updates expected Markdown output to include inline fenced blocks for complex inputs.
engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl	Changes parameter rendering to switch between inline vs fenced-block formatting based on newlines.
engine/cld/mcms/proposalanalysis/renderer/golden_test.go	Extends the golden proposal inputs to exercise multiline/structured params and bytes formatting.
engine/cld/mcms/proposalanalysis/renderer/funcmap.go	Adds helper funcs for detecting newlines and indenting multiline values in templates.
.changeset/five-colts-yawn.md	Records the patch-level change for release tooling.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

This PR improves the Markdown renderer used by the MCMS proposal analysis framework so that complex (multi-line) parameter values are displayed inline as indented fenced blocks, matching the legacy/expected presentation and updating golden outputs accordingly.

Changes:

Render parameter values containing newlines as indented fenced text blocks under the parameter bullet.
Add hasNewline and indentLines template helpers to support multi-line formatting.
Expand/update golden fixtures and tests to cover complex parameter rendering (including nested JSON-like structures and bytes).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl	Detects multi-line formatted values and renders them as indented fenced blocks.
engine/cld/mcms/proposalanalysis/renderer/funcmap.go	Adds `hasNewline` and `indentLines` helpers to the template func map.
engine/cld/mcms/proposalanalysis/renderer/golden_test.go	Extends the golden proposal to include complex params (bytes + structured slice) to exercise the new rendering.
engine/cld/mcms/proposalanalysis/renderer/testdata/golden_markdown.md	Updates renderer golden output to reflect the new multi-line parameter formatting.
engine/cld/mcms/proposalanalysis/examples/ccip/analyzers/tokenpool/testdata/golden_markdown.md	Updates example analyzer golden output to match the renderer’s updated formatting/spacing.
.changeset/five-colts-yawn.md	Adds a patch changeset entry for the Markdown rendering fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Render multiline parameter values as indented text blocks within input bullets and expand golden test coverage.

Copilot

Pull request overview

Updates the markdown renderer in the proposal analysis framework to render multiline/complex parameter values in a readable, legacy-like format, and extends golden coverage to validate the new rendering behavior.

Changes:

Render parameters with multiline formatted values as fenced text blocks within the input bullet.
Add template helper functions (hasNewline, indentLines) to support the new markdown formatting.
Expand the markdown golden fixture and its generating test proposal to include complex, multiline parameters.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl	Switches multiline parameter rendering to an indented fenced block under the parameter bullet.
engine/cld/mcms/proposalanalysis/renderer/funcmap.go	Adds `hasNewline` and `indentLines` template helpers and exposes them via the func map.
engine/cld/mcms/proposalanalysis/renderer/golden_test.go	Extends the golden proposal with `bytes` and a complex slice/struct parameter to exercise multiline rendering.
engine/cld/mcms/proposalanalysis/renderer/testdata/golden_markdown.md	Updates expected markdown output to include the new multiline parameter block rendering.
.changeset/five-colts-yawn.md	Adds a patch changeset entry for the renderer output fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl

cl-sonarqube-production · 2026-03-17T03:04:58Z

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
88.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

@graham-chainlink

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## chainlink-deployments-framework@0.88.1 ### Patch Changes - [#858](#858) [`b05a8f2`](b05a8f2) Thanks [@graham-chainlink](https://github.com/graham-chainlink)! - fix(mcms/analyzer/renderer): inline complex parameter values in markdown - [#853](#853) [`7b0467c`](7b0467c) Thanks [@finleydecker](https://github.com/finleydecker)! - fix: make RPC health check timeout configurable Co-authored-by: Graham Goh <graham.goh@smartcontract.com>

graham-chainlink marked this pull request as ready for review March 16, 2026 03:22

graham-chainlink requested a review from a team as a code owner March 16, 2026 03:22

Copilot AI review requested due to automatic review settings March 16, 2026 03:22

Copilot started reviewing on behalf of graham-chainlink March 16, 2026 03:23 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

graham-chainlink force-pushed the ggoh/NO-JIRA/inline-parameter-block-formatting branch 2 times, most recently from 92bc46b to f01cb71 Compare March 16, 2026 03:36

Copilot AI review requested due to automatic review settings March 16, 2026 03:36

Copilot started reviewing on behalf of graham-chainlink March 16, 2026 03:37 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

ecPablo previously approved these changes Mar 16, 2026

View reviewed changes

graham-chainlink force-pushed the ggoh/NO-JIRA/inline-parameter-block-formatting branch from f01cb71 to 2d70a6a Compare March 17, 2026 02:25

Copilot AI review requested due to automatic review settings March 17, 2026 02:25

graham-chainlink dismissed ecPablo’s stale review via 6c7c821 March 17, 2026 02:25

graham-chainlink force-pushed the ggoh/NO-JIRA/inline-parameter-block-formatting branch from 2d70a6a to 6c7c821 Compare March 17, 2026 02:25

Copilot started reviewing on behalf of graham-chainlink March 17, 2026 02:26 View session

Copilot AI reviewed Mar 17, 2026

View reviewed changes

graham-chainlink force-pushed the ggoh/NO-JIRA/inline-parameter-block-formatting branch from 6c7c821 to 4c70573 Compare March 17, 2026 02:34

fix(mcms/analyzer): inline complex parameter values in markdown

319e513

Render multiline parameter values as indented text blocks within input bullets and expand golden test coverage.

graham-chainlink force-pushed the ggoh/NO-JIRA/inline-parameter-block-formatting branch from 4c70573 to 319e513 Compare March 17, 2026 02:57

Copilot AI review requested due to automatic review settings March 17, 2026 02:57

Copilot started reviewing on behalf of graham-chainlink March 17, 2026 02:58 View session

Copilot AI reviewed Mar 17, 2026

View reviewed changes

engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl Show resolved Hide resolved

graham-chainlink requested a review from ecPablo March 17, 2026 03:47

gustavogama-cll approved these changes Mar 17, 2026

View reviewed changes

graham-chainlink added this pull request to the merge queue Mar 17, 2026

Merged via the queue into main with commit b05a8f2 Mar 17, 2026
25 checks passed

graham-chainlink deleted the ggoh/NO-JIRA/inline-parameter-block-formatting branch March 17, 2026 05:08

app-token-issuer-engops bot mentioned this pull request Mar 17, 2026

Version Packages #863

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(mcms/analyzer/renderer): inline complex parameter values in markdown for new proposal analysis framework#858

fix(mcms/analyzer/renderer): inline complex parameter values in markdown for new proposal analysis framework#858
graham-chainlink merged 1 commit intomainfrom
ggoh/NO-JIRA/inline-parameter-block-formatting

graham-chainlink commented Mar 16, 2026

Uh oh!

changeset-bot bot commented Mar 16, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

cl-sonarqube-production bot commented Mar 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

graham-chainlink commented Mar 16, 2026

Uh oh!

changeset-bot bot commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

cl-sonarqube-production bot commented Mar 17, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Mar 16, 2026 •

edited

Loading