Automate GitHub Releases

[lhazlewood]

From #780 (comment):

@hertg do you know if there's a way [GitHub Releases] can be automated? Ideally I'd rather not add another manual step to the release process, but we can certainly discuss how best to go about this.

@lhazlewood There is. I usually use the softprops/action-gh-release Github Action to automatically create Github Releases when I push tags. Here's an example from a project of mine: https://github.com/leftwm/leftwm-layouts/blob/ec4280dabebe2850ee39bb96808b2914c48abc9f/.github/workflows/publish.yml#L39-L43

Note

The body_path and prerelease arguments are optional, that's just a personal preference of mine. I usually have a CHANGELOG.md file in the repository which contains the release notes for the next release only.

With this configuration it will create a Github Release when I push a tag and use the contents of CHANGELOG.md as the release notes. The prerelease as I defined it will automatically mark the Github Release as "Prerelease" if the tag version contains -rc. (e.g. v1.2.0-rc.1).

I have some other projects where it also automatically adds the compiled binaries as attachments to the Github Release. That's probably more than what you're looking for, but just in case you're interested here's the link for that.

Originally posted by @hertg in #780 (comment)