feat: escape Markdown syntax in changelog titles

[germa89]

It seems there is not way to check if Markdown syntax is correct or not (Ref: https://stackoverflow.com/questions/25331366/markdown-syntax-checking-for-continous-integration)

Hence I am going with a more humble approach.

Close #696

[ansys-reviewer-bot]

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

[germa89]

By the way, I keep having this, @klmcadams you might want to check.. maybe it is my python version though...

> git -c user.useConfigOnly=true commit --quiet --allow-empty-message --file -
black....................................................................Passed
isort....................................................................Passed
flake8...................................................................Failed
- hook id: flake8
- exit code: 1

python-utils/parse_pr_title.py:247:46: E231 missing whitespace after ':'
python-utils/parse_pr_title.py:248:50: E231 missing whitespace after ':'
python-utils/parse_pr_title.py:251:45: E231 missing whitespace after ':'
python-utils/parse_pr_title.py:252:46: E231 missing whitespace after ':'

check for merge conflicts................................................Passed
check yaml...........................................(no files to check)Skipped
fix requirements.txt.................................(no files to check)Skipped
trim trailing whitespace.................................................Passed
debug statements (python)................................................Passed
Validate GitHub Workflows............................(no files to check)Skipped
Add License Headers..................................(no files to check)Skipped

[germa89]

Kinda shocking we do not have the changelog action activated on the changelog repo hahhaha

[RobPasMue]

Kinda shocking we do not have the changelog action activated on the changelog repo hahhaha

#690 only for you... 🙃

[SMoraisAnsys]

Kinda shocking we do not have the changelog action activated on the changelog repo hahhaha

We dont want to be our own nightmare :D

[SMoraisAnsys]

I know we already discussed about it in the past but we might want to extend the scope of check-pr-title by checking that a title only contains alpha / digit / spaces characters ? From this changes requirement, I'm expecting other people coming in the future because they are using other characters leveraged in MD, e.g. [, ], >, #, ...
This would also adress #696 as people would we notified that they are using invalid characters.

[germa89]

Kinda shocking we do not have the changelog action activated on the changelog repo hahhaha

#690 only for you... 🙃

You saying I'm special?..... mmmhhh..... special, I like that...

https://youtu.be/aI0euMFAWF8?si=92b0RduZDJ5ugyG0&t=56

[jorgepiloto]

I know we already discussed about it in the past but we might want to extend the scope of check-pr-title by checking that a title only contains alpha / digit / spaces characters ? From this changes requirement, I'm expecting other people coming in the future because they are using other characters leveraged in MD, e.g. [, ], >, #, ... This would also adress #696 as people would we notified that they are using invalid characters.

I fully agree about this. Also, note that the changelog templates using Sphinx-design cards may suffer from rendering issues if symbols are included.

Following @SMoraisAnsys suggestion, I would prefer to block the use of symbols rather than trying to escape them. This just adds more symbols to the fragment.

[RobPasMue]

So, shall we just close this and tackle a refactoring that does not support any kind of rich syntax? (neither MD, rST...)

[SMoraisAnsys]

So, shall we just close this and tackle a refactoring that does not support any kind of rich syntax? (neither MD, rST...)

I agree with closing this PR. Note that it would be wise that the refactoring is compatible with !, ( and ) since we emphasize the use of conventional commit and this are symbols used to define scope and breaking changes. See #722 for example :D

[jorgepiloto]

Closing this after the discussion.