microsoft / coe-starter-kit

Other
739 stars 216 forks source link

[ALM Accelerator - BUG]: Notes / Commit Messages containing quotes terminates pipeline unexpectedly #8727

Open Reinhard-S opened 1 month ago

Reinhard-S commented 1 month ago

Describe the issue

Hello,

This is a follow-up request on #4053. We encountered an issue while committing a solution over ALM Accelerator when a quote is contained within the notes (commit) text message.

Looking into our Pipelines repo i noticed a difference in /PowerShell/load-save-pipeline-parameters.ps1 - double quotes have been replaced by a single quote on the comment. I guess originally this should address the issue but unfortunately a comment like '#1091 - Lead - show "Current URL" in Merge dialog' breaks the script and makers don't even know where to start investigating at all.

Could you please address this issue e.g. by being explicitly naming parameters?

Thanks, Kind Regards, Reinhard

PS - Changes in load-save-pipeline-parameters.ps1:

Old: Write-Export-Pipeline-Parameters "$(Agent.BuildDirectory)\export-pipeline-parameters.json" "${{ parameters.gitAccessUrl }}" "${{ parameters.project }}" "${{ parameters.repo }}" "${{ parameters.branch }}" "${{ parameters.branchToCreate }}" "${{ parameters.commitMessage }}" "${{ parameters.email }}" "${{ parameters.serviceConnectionName }}" "${{ parameters.serviceConnectionUrl }}" "${{ parameters.solutionName }}" "${{ parameters.userName }}"

New: Write-Export-Pipeline-Parameters "$(Agent.BuildDirectory)\export-pipeline-parameters.json" "${{ parameters.gitAccessUrl }}" "${{ parameters.project }}" "${{ parameters.repo }}" "${{ parameters.branch }}" "${{ parameters.branchToCreate }}" '${{ parameters.commitMessage }}' "${{ parameters.email }}" "${{ parameters.serviceConnectionName }}" "${{ parameters.serviceConnectionUrl }}" "${{ parameters.solutionName }}" "${{ parameters.userName }}"

Expected Behavior

Notes / Commit message content should not affect the commit in any way.

What component are you experiencing the issue with?

ALM Accelerator Canvas App

What solution version are you using?

1.0.20240305.1

Steps To Reproduce

Try to commit some solution providing a message containig a string.

Anything else?

No response

MaheshSripada commented 1 month ago

Hi @Reinhard-S

This looks like an issue in the Powershell. As a workaround, can you please avoid adding comments with single quotes. We will add this to our backlog and consider for code fixes for future release.

cc - @Ramakrishnan24689

Reinhard-S commented 1 month ago

Hi @MaheshSripada,

Thanks for looking into it and yes, I already advised our makers to follow the rule of not adding any quotes into the comment for the time being. I'm already curious on the solution you guys come up with, as I also had similar issues in the past. ;-)

Best Regards, Reinhard