check_formalities: escape LaTeX special characters in output

[BKPepe]

The script currently inserts substrings of the commit subject and body directly into LaTeX-formatted strings for GitHub Actions output. If these substrings contain special LaTeX characters (such as underscore '_'), it causes the LaTeX rendering to fail in the CI output.

This commit introduces a helper function 'escape_latex' in 'src/helpers.sh'
which escapes common LaTeX special characters
('', '_', '$', '&', '%', '#', '{', '}').

The 'check_formalities.sh' script is updated to use this function when preparing the failure output, ensuring that the generated LaTeX is valid regardless of the commit content.

Fixes: #12 (comment)

[Copilot]

Pull request overview

This PR fixes LaTeX rendering failures in GitHub Actions output by escaping special characters in commit messages. The issue occurred when commit subjects or bodies contained LaTeX special characters (like underscores), causing the CI output rendering to fail.

Changes:

• Added escape_latex helper function to escape common LaTeX special characters
• Updated output_split_fail and output_split_fail_ex functions to apply escaping before generating LaTeX output

Reviewed changes

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

File	Description
src/helpers.sh	Introduces new escape_latex function to escape LaTeX special characters (backslash, underscore, dollar, ampersand, percent, hash, braces)
src/check_formalities.sh	Updates output functions to escape commit text before inserting into LaTeX-formatted GitHub Actions output

---

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

[BKPepe]

Always fun with Copilot.

[GeorgeSapkin]

After enabling comments in luci, looks like LaTeX coloring and escaping is borked (I left the broken ones only):

From:

• luci-app-dockerman: proper handling of hostIP in ports openwrt/luci#8422

Commit 987137f4fdd4c3343df9f251b2b08b313ed23a85

• 🔶 Commit message lines should be <= 75 characters long
  Actual: line 2 is 111 characters long
  $\textsf{This makes the new --cert-profile option from https://github.com/openwrt/pa\color{red}{ckages/pull/28237 available in Luci.}}$

Commit 5e524e8e0fa21b28968462a87f40370b512adc39

• 🔶 Commit message lines should be <= 75 characters long
  Actual: line 2 is 83 characters long
  $\textsf{Fix incorrect @Lends, @name, @Class, and @classdesc annotations to match th\color{red}{e actual}}$

Commit 78a62f261bb956b3246eb8b7a1c85b794d9229a2

• 🔶 Commit subject must be <= 80 (and should be <= 60) characters long
  Actual: subject is 77 characters long
  $\textsf{luci-app-acme: fixed the issue where certificates were not d\color{yellow}{isplaying (#8151)}\color{red}{}}$

Commit 21eeb6e9f76f9b074c3ec9a3be3577bd508613f4

• 🔶 Commit message lines should be <= 75 characters long
  Actual: line 2 is 87 characters long
  $\textsf{Changes DHCPv6 statistics display to tooltips in IPv6 Upstream network inte\color{red}{rface boxes.}}$

Commit 2106f0952f5c0cc0a307b9146e6ffd28505e06e7

• ❌ Commit subject must be <= 80 (and should be <= 60) characters long
  Actual: subject is 103 characters long
  $\textsf{luci-base: add responseProgress callback and stderr opti\color{yellow}{on for LuCI.request }\color{red}{and fs.exec\_direct().}}$

I'm thinking if it even makes sense fixing it at this point.