[Feature Request] Email Updates
-
@girish this took longer than expected, but here is the Merge Request. Happy to get your notes on it and make adjustments where needed. Turns out getting the Release Body for both Github and Gitlab was challenging since their API's do not line up 1-to-1. Hopefully this is a decent solution around that.
@thetomester13 thanks! I merged it. It seems that highlight.js which comes from helper-markdown is deprecated. I see this when installing (there's upstream issues https://github.com/helpers/helper-markdown/issues/15 and https://github.com/helpers/helper-markdown/issues/14 about this):
> highlight.js@9.18.5 postinstall /home/girish/yellowtent/releasebell/node_modules/highlight.js > node deprecated.js -*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* Verion 9 of Highlight.js has reached EOL. It will no longer be supported or receive security updates in the future. Please upgrade to version 10 or encourage your indirect dependencies to do so. For more info: https://github.com/highlightjs/highlight.js/issues/2877 https://github.com/highlightjs/highlight.js/blob/master/VERSION_10_UPGRADE.md -*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* -
I had some thoughts about updates for the emails that ReleaseBell sends out.
- The emails themselves can be mobile friendly. Right now if I open an email on my phone it's zoomed all the way out and I can't make out what it's saying without zooming in. I believe this should be pretty straight forward.
- Can each email include the blurb from the release? This would make it so that you don't have to leave your email client to see what the updates actually were (at least in cases where the repo owner added a blurb to the release at all).
Finally, I volunteer to contribute these updates if it's interesting at all and welcome?
@thetomester13 Given that it's really just one file - https://github.com/helpers/helper-markdown/blob/master/index.js, do you think we can just remove usage of that module entirely? Just put that file in releasebell itself (or make a function) and bump the deps?
-
@thetomester13 Given that it's really just one file - https://github.com/helpers/helper-markdown/blob/master/index.js, do you think we can just remove usage of that module entirely? Just put that file in releasebell itself (or make a function) and bump the deps?
@girish yikes, totally missed the fact that helpers/helper-markdown is not really supported anymore, quite unfortunate as it seems the author just stopped responding
do you think we can just ... put that file in releasebell itself (or make a function) and bump the deps?
Anyway, yes, I think this is a fine way to move forward. Unfortunately, the now-deprecated module was the best solution I found to render Markdown in handlebars. And as you mentioned, since it's quite straight forward, pulling it into ReleaseBell probably wouldn't be a big deal. Even more so, I don't believe we use the
hightlightmethod defined on line 40, so we shouldn't even need to bring in thehighlight.jspackage. -
@girish yikes, totally missed the fact that helpers/helper-markdown is not really supported anymore, quite unfortunate as it seems the author just stopped responding
do you think we can just ... put that file in releasebell itself (or make a function) and bump the deps?
Anyway, yes, I think this is a fine way to move forward. Unfortunately, the now-deprecated module was the best solution I found to render Markdown in handlebars. And as you mentioned, since it's quite straight forward, pulling it into ReleaseBell probably wouldn't be a big deal. Even more so, I don't believe we use the
hightlightmethod defined on line 40, so we shouldn't even need to bring in thehighlight.jspackage. -
@thetomester13 I guess in the long run we can move this to markdown-it which seems to be properly supported
-
@nebulon that's a great point! I was always looking at how to integrate Markdown rendering with the Handlebars templating, but we could simply try to get Markdown as HTML and then pass it into the email template.
@thetomester13 we are running the new version currently for testing still and it is a huge improvement. Thanks @thetomester13 totally worth it
-
Indeed, it's pretty great. In fact, just one day in, I don't know how I lived without this for so long
(on a side note, there was a crash which I have fixed).
-
Indeed, it's pretty great. In fact, just one day in, I don't know how I lived without this for so long
(on a side note, there was a crash which I have fixed).
-
Indeed, it's pretty great. In fact, just one day in, I don't know how I lived without this for so long
(on a side note, there was a crash which I have fixed).
@girish said in [Feature Request] Email Updates:
Indeed, it's pretty great. In fact, just one day in, I don't know how I lived without this for so long
What's the workflow that so much better?
-
@girish said in [Feature Request] Email Updates:
Indeed, it's pretty great. In fact, just one day in, I don't know how I lived without this for so long
What's the workflow that so much better?
@robi the release information is now straight in the new release notitfication email. Previously, one had to click through and visit via the browser etc.
-
@robi the release information is now straight in the new release notitfication email. Previously, one had to click through and visit via the browser etc.
-
-
@thetomester13 ah yes, sorry forgot about this. We are using it already for some time now and initial issues were fixed, so no reason not to update it. Will go ahead now.
that makes me happy to hear! Glad I can contribute!