From 1266be453ea194a58f417616713d466bedba0f68 Mon Sep 17 00:00:00 2001 From: Paul Razvan Berg Date: Sat, 12 Mar 2022 12:43:27 +0000 Subject: [PATCH] docs: update github release faq item --- source/en/1.1.0/index.html.haml | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/source/en/1.1.0/index.html.haml b/source/en/1.1.0/index.html.haml index c6d6fdf5..7e6dfebe 100644 --- a/source/en/1.1.0/index.html.haml +++ b/source/en/1.1.0/index.html.haml @@ -16,6 +16,7 @@ version: 1.1.0 - ghr = "https://help.github.com/articles/creating-releases/" - gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs" - gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File" +- gitrelease = "https://github.com/anton-yurchenko/git-release" .header .title @@ -249,15 +250,9 @@ version: 1.1.0 %p GitHub Releases create a non-portable changelog that can only be displayed to users within the context of GitHub. It's possible to - make them look very much like the Keep a Changelog format, but it - tends to be a bit more involved. - - %p - The current version of GitHub releases is also arguably not very - discoverable by end-users, unlike the typical uppercase files - (README, CONTRIBUTING, etc.). Another - minor issue is that the interface doesn't currently offer links to - commit logs between each release. + make them look very much like the Keep a Changelog format. In fact, + there is a GitHub Action called #{link_to "git-release", gitrelease} + that can populate the release notes from your changelog file. %h4#automatic %a.anchor{ href: "#automatic", aria_hidden: "true" }