readthedocs / actions

GitHub Actions for Read the Docs
MIT License
33 stars 10 forks source link

action.yaml: fix message-template #32

Closed pjonsson closed 8 months ago

pjonsson commented 9 months ago

The message template contains four dashes, and that apparently makes Github not render the following books emoji. Use three dashes instead.

The non-displaying emojis can be seen in #12, or #16 for something more recent.


:books: Documentation preview :books: : https://readthedocs-preview--32.org.readthedocs.build/en/32/

pjonsson commented 9 months ago

This requires #33 to be merged before passing the CI.

Jamim commented 8 months ago

Hello @pjonsson, Thank you for the fix! 🙇🏻‍♂️

For the sake of transparency:

humitos commented 8 months ago

Testing triple dash rendering here...


... continues here.

humitos commented 8 months ago

Checking if it works in the same way as four dashes...


... continues here.

humitos commented 8 months ago

Checking again...

... continues here.

humitos commented 8 months ago

Checking again...

... continues here.

humitos commented 8 months ago

Checking again...

:books:: continues here.

humitos commented 8 months ago

Checking again...

:books:: continues here.

humitos commented 8 months ago

I did some tests here and I wasn't able to reproduce the issue. Please, see https://github.com/readthedocs/actions/issues/34#issuecomment-1849854607 to see how we continue moving forward.

pjonsson commented 8 months ago

I did some tests here and I wasn't able to reproduce the issue. Please, see #34 (comment) to see how we continue moving forward.

Not being able to reproduce seems concerning. Here's a screenshot of this PR from my screen:

image

The lower left corner contains the characters "books" between colons, rather than an emoji of books, so this repository is still affected for at least some of us.

humitos commented 8 months ago

The lower left corner contains the characters "books" between colons, rather than an emoji of books, so this repository is still affected for at least some of us.

I see the same here. I tried editing the description to remove a - and I was not able to make it work 🤷🏼

humitos commented 8 months ago

Also, I don't know why it started to failed now. I was working before. So, GitHub has changed something?

pjonsson commented 8 months ago

Your main repository uses a custom message, so you don't see the issue there. (That is where I found the solution to the problem.)

12 is from August 2022, so it's been around for a while.

I did this PR 9 days ago so I don't remember when you added the XML comment to keep track of the URL, but it's possible that is what caused things to break.

pjonsson commented 8 months ago

Even if this PR is wrong, could you check/reject-and-make-some-other-fix #33 first so PRs to this repository aren't automatically red?

humitos commented 8 months ago

I merged #37 which uses the real emoji instead of :books:. After opening a new PR https://github.com/readthedocs/actions/pull/38 I can see the emojis properly rendered there. @egeakman @pjonsson let me know if it works for you.

pjonsson commented 8 months ago

Strange, my first attempt at fixing this was identical to your PR, but didn't work for some reason.

It works now though, thanks!