Skip to content

Update to handle double-quotes in release notes#1651

Merged
harrisonmeister merged 2 commits intomasterfrom
fix-slack-details
Feb 24, 2026
Merged

Update to handle double-quotes in release notes#1651
harrisonmeister merged 2 commits intomasterfrom
fix-slack-details

Conversation

@twerthi
Copy link
Contributor

@twerthi twerthi commented Feb 24, 2026


Background

Customer submitted report that slack step was failing. Engineering determined that it was because double-quotes were in the Release Notes field.

Results

Script converts double-quotes to JSON double-quotes.

Before

Community Template would fail when double-quotes were included in the Release Notes field.

After

Template no longer fails and displays double-quotes in release notes correctly within the Slack message.

Pre-requisites

  • Id should be a GUID that is not 00000000-0000-0000-0000-000000000000
    • NOTE If you are modifying an existing step template, please make sure that you do not modify the Id property (updating the Id will break the Library sync functionality in Octopus).
  • Version should be incremented, otherwise the integration with Octopus won't update the step template correctly
  • Parameter names should not start with $
  • Step template parameter names (the ones declared in the JSON, not the script body) should be prefixed with a namespace so that they are less likely to clash with other user-defined variables in Octopus (see this issue). For example, use an abbreviated name of the step template or the category of the step template).
  • LastModifiedBy field must be present, and (optionally) updated with the correct author
  • The best practices documented here have been applied
  • If a new Category has been created:
    • An image with the name {categoryname}.png must be present under the step-templates/logos folder
    • The switch in the humanize function in gulpfile.babel.js must have a case statement corresponding to it

@github-actions
Copy link

Start Hyponome locally

docker pull ghcr.io/hnrkndrssn/hyponome:main
docker run --rm -p 8000:8080 -it ghcr.io/hnrkndrssn/hyponome:main

Review in Hyponome

Copy link
Contributor

@harrisonmeister harrisonmeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@harrisonmeister harrisonmeister merged commit 7246152 into master Feb 24, 2026
3 checks passed
@harrisonmeister harrisonmeister deleted the fix-slack-details branch February 24, 2026 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants