Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: properly render 🚮 in default templates #4044

Merged
merged 1 commit into from
Dec 13, 2023

Conversation

glasser
Copy link
Contributor

@glasser glasser commented Dec 12, 2023

what

It seems that GitHub has changed its Markdown renderer such that an emoji followed by a string of plain text (with no other formatting) followed by a colon at the end of the line renders as plain text instead of as the emoji. Compare the following three lines:

  • 🚮 To delete all plans and locks for the PR, comment:

  • 🚮 To delete all plans and locks for the PR, comment

  • 🚮 To delete all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it by adding some formatting between the emoji and the end of the line, which matches the bullet point above it anyway.

why

It's ugly to see spelled-out emoji instead of the emoji.

tests

Just look a few lines up in this message to see the impact.

It seems that GitHub has changed its Markdown renderer such that an
emoji followed by a string of plain text (with no other formatting)
followed by a colon at the end of the line renders as plain text instead
of as the emoji. Compare the following two lines:

* 🚮 To delete all plans and locks for the PR, comment:

* 🚮 To **delete** all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it
by adding some formatting between the emoji and the end of the line,
which matches the bullet point above it anyway.
@glasser glasser requested a review from a team as a code owner December 12, 2023 23:19
@glasser
Copy link
Contributor Author

glasser commented Dec 12, 2023

For future reference in case GitHub changes the renderer again:

image

@glasser glasser changed the title Fix rendering of 🚮 in default templates fix: properly render 🚮 in default templates Dec 12, 2023
@GenPage GenPage added bug Something isn't working templates labels Dec 13, 2023
Copy link
Member

@GenPage GenPage left a comment

Choose a reason for hiding this comment

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

Thank you for catching this

@GenPage
Copy link
Member

GenPage commented Dec 13, 2023

/cherry-pick release-0.27

@GenPage GenPage merged commit bcd9196 into runatlantis:main Dec 13, 2023
23 of 25 checks passed
gcp-cherry-pick-bot bot pushed a commit that referenced this pull request Dec 13, 2023
It seems that GitHub has changed its Markdown renderer such that an
emoji followed by a string of plain text (with no other formatting)
followed by a colon at the end of the line renders as plain text instead
of as the emoji. Compare the following two lines:

* 🚮 To delete all plans and locks for the PR, comment:

* 🚮 To **delete** all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it
by adding some formatting between the emoji and the end of the line,
which matches the bullet point above it anyway.
lukemassa pushed a commit that referenced this pull request Dec 20, 2023
It seems that GitHub has changed its Markdown renderer such that an
emoji followed by a string of plain text (with no other formatting)
followed by a colon at the end of the line renders as plain text instead
of as the emoji. Compare the following two lines:

* 🚮 To delete all plans and locks for the PR, comment:

* 🚮 To **delete** all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it
by adding some formatting between the emoji and the end of the line,
which matches the bullet point above it anyway.
lukemassa pushed a commit that referenced this pull request Dec 20, 2023
It seems that GitHub has changed its Markdown renderer such that an
emoji followed by a string of plain text (with no other formatting)
followed by a colon at the end of the line renders as plain text instead
of as the emoji. Compare the following two lines:

* 🚮 To delete all plans and locks for the PR, comment:

* 🚮 To **delete** all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it
by adding some formatting between the emoji and the end of the line,
which matches the bullet point above it anyway.

Co-authored-by: David Glasser <glasser@apollographql.com>
ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request Feb 13, 2024
It seems that GitHub has changed its Markdown renderer such that an
emoji followed by a string of plain text (with no other formatting)
followed by a colon at the end of the line renders as plain text instead
of as the emoji. Compare the following two lines:

* 🚮 To delete all plans and locks for the PR, comment:

* 🚮 To **delete** all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it
by adding some formatting between the emoji and the end of the line,
which matches the bullet point above it anyway.
ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request Feb 13, 2024
It seems that GitHub has changed its Markdown renderer such that an
emoji followed by a string of plain text (with no other formatting)
followed by a colon at the end of the line renders as plain text instead
of as the emoji. Compare the following two lines:

* 🚮 To delete all plans and locks for the PR, comment:

* 🚮 To **delete** all plans and locks for the PR, comment:

While this seems like it is probably a GitHub bug, we can work around it
by adding some formatting between the emoji and the end of the line,
which matches the bullet point above it anyway.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working templates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants