Prevent < and > in commit titles from breaking dag-sync slack message

[AetherUnbound]

Description

This PR fixes an issue that arose when #2817 was merged: the commit title timestamp_created -> timestamp_update (#2817) broke the Slack message component of the DAG sync since the > character was interpreted by Slack as the end of the link definition.

This change adds a step to replace the < and > character with two variants (≺ and ≻ respectively). These characters, though they look roughly similar, don't register in Slack as delimiters and thus don't break the message syntax when merged!

Testing Instructions

This was tested in our Slack instance:

Before

After

Checklist

• My pull request has a descriptive title (not a vague title likeUpdate index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.
• I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[obulat]

Why not convert them to an HTML entity as described in the docs¹?

• Replace the less-than sign, < with <
• Replace the greater-than sign, > with >

Footnotes

1. https://api.slack.com/reference/surfaces/formatting#escaping ↩

[AetherUnbound]

That is a much better idea! I'll give that a shot 😁

[dhruvkb]

This PR also broke our Slack notification.

[dhruvkb]

This is creative, but @obulat's solution of using < and > seems more "right".

[AetherUnbound]

Updated to use the HTML entities instead! I also confirmed this works as expected:

[dhruvkb]

LGTM! Thanks for the screenshot showing that it works.

[dhruvkb]

I would've thought that the & or ; would need another layer of escaping.

[AetherUnbound]

Me too, but apparently not since it's in ${...}!

[krysal]

Great solution 💯