Alt-tab-macos: Github release log doesn't render the content nicely as markup

Created on 10 Sep 2020  路  1Comment  路  Source: lwouis/alt-tab-macos

Currently it looks like this, e.g. from https://github.com/lwouis/alt-tab-macos/releases/tag/v6.5.0

image

The content though (to me clearly) looks like GFM so it would be nice if it would render appropriately:

image

Means also links would be directly clickable etc.

enhancement

Most helpful comment

I use Travis for CI/CD. They have a Github Releases script. It can take a body param for release notes, but apparently it can't contain Markdown. They seem to have added markdown support in a new param called release_notes, but this new param is only available on dpl v2, which has been in beta for a year now.

I'm a bit hesitant to opt-in dpl v2, and potentially have problems in the next releases, just to get markdown text to look nice in the releases.

Release notes are currently available:

Another approach would be to ditch dpl, and make github API calls directly.

Overall it's always a pain to touch CI/CD, as there is no way to test and make sure the change wouldn't break everything, before it goes live on production. I wish CI systems had ways to be tested before hands, but it's kind of the nature of it to be production-facing, thus you don't know if it really works until you pull the lever.

I'll keep this ticket open as a reminder

>All comments

I use Travis for CI/CD. They have a Github Releases script. It can take a body param for release notes, but apparently it can't contain Markdown. They seem to have added markdown support in a new param called release_notes, but this new param is only available on dpl v2, which has been in beta for a year now.

I'm a bit hesitant to opt-in dpl v2, and potentially have problems in the next releases, just to get markdown text to look nice in the releases.

Release notes are currently available:

Another approach would be to ditch dpl, and make github API calls directly.

Overall it's always a pain to touch CI/CD, as there is no way to test and make sure the change wouldn't break everything, before it goes live on production. I wish CI systems had ways to be tested before hands, but it's kind of the nature of it to be production-facing, thus you don't know if it really works until you pull the lever.

I'll keep this ticket open as a reminder

Was this page helpful?
0 / 5 - 0 ratings