remkop
commented
4 years ago Looks like there is a GitHub Action workflow that automatically creates a GitHub Release when a tag is pushed whose tag name starts with 'v': https://github.com/actions/create-release
This may be simplest: no need to modify the release.bash script.
Regarding Release Notes: there is a body_path parameter that can be pointed to a RELEASE_NOTES.md file.
Alternatively, we can use the GitHub REST API: https://developer.github.com/v3/repos/releases/#input
The JSON to send looks fairly straightforward:
{
"tag_name": "v1.0.0",
"target_commitish": "master",
"name": "v1.0.0",
"body": "Description of the release",
"draft": false,
"prerelease": false
}The authentication may be an issue when calling the REST API; we would need to specify a token. We may be able to get this from the git config (see this example).
Example curl command:
curl -v -s \
-H "Authorization: token xxxxxxxxx" \
-H "Content-Type:application/json" \
"https://api.github.com/repos/:owner/:repo/releases" \
-d '{ "user" : { "email" : "XXXXXXX", "password" : "XXXXX"}, "tag_name": "1.2.1", "target_commitish": "master", "name": "1234", "body": "Release of version 1234", "draft": false, "prerelease": false}'
See if it is feasible/what is involved to publish a GitHub Release from the
release.bashscript.That would make the
release.bashscript a true "one push" button that does the full release all the way up to publishing the distribution zip with ami binaries to GitHub Packages.This likely involves making a
curlcall to the GitHub REST API.Release Notes are an open issue here.
Now that we have more formal releases, I think it makes sense for each release to have release notes. This could be as simple as a summary and a list of issues fixed.
In the picocli project I track all changes in GitHub issues and group them in "Milestones" that correspond to releases. I have a separate RELEASE_NOTES.md file in the project where I write a post for each release. This is quite a lot of work, we can be less formal, but some release notes would be nice and we should think about where to store them.