First of all,
for this effort.
Yes please. Documenting the steps is the first step to automating them.
Over time I wouldn’t mind having some common process documented somewhere (like on theforeman.org) and the release.md file just points to that.
Some implementation detail: I’d prefer not to have this file end up in release artifacts (like gems). Otherwise we need to deal with it in packaging (RPM/deb). There’s also a tiny saving on size (both storage and transfer).
I suggested this in the past:
I’ve already removed all API tokens from our own theforeman account and converted workflows where needed.