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.

Sign up for GitHub

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

docs: update GitHub Release faq item #427

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −9
Open

docs: update GitHub Release faq item #427

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions source/en/1.1.0/index.html.haml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
(<code>README</code>, <code>CONTRIBUTING</code>, 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" }
Expand Down