A few days ago, I posted to desktop-devel-list asking how we can ensure releases happen, especially beta releases for the freeze. I was frustrated and my language was too abrasive, and I’m sorry for that. My intention was really to open a discussion on how we can improve our release process. Emmanuele replied with a thorough analysis of which bits are hard to automate, which I enjoyed reading.
Earlier today, I tweeted asking developers of other open source projects how they make releases, just to get a sense of what the rest of the world does. There have been a lot of responses, and it will take me a while to digest it all.
In the meantime, I wanted to share my process for rolling releases. I maintain five core GNOME modules, plus a handful of things in the wider open source world. My release process hasn’t fundamentally changed in the 18 years I’ve been a maintainer. A lot of other stuff has changed (merge requests, CI, freeze break approvals, etc), so I’m just trying to think of how any of this could be better. Anyway, here’s my process:
- First, I run
git statusin my development checkout to do a sanity check for files I forgot to add to the repo. In at least one project, I have auto-generated docs files that I keep in git, because various tools rely on them being there.
- Next, I always want to make sure I’m making releases from a clean checkout. So I will
git clonea fresh checkout. Or sometimes, I already have a checkout I use just for releases, so I will
- Next, I actually roll a tarball before doing anything else, which I will promptly throw away. I’ve had a few times where I discovered a dist breakage after doing everything else, and I’ve had to start over.
- Now it’s time to write a
NEWSentry. I run
git log --stat PREVTAG.. > changes, where
PREVTAGis the tag name of the previous release. I edit
changesto turn it into a
NEWSentry, then I copy it to the top of the
- I then bump the version number in either
meson.build. I know a lot of people do pre-release version bumps. I don’t have a strong opinion on this, so I’ve never changed my habits.
- Now it’s time to roll the tarball that I don’t throw away. The commands I run depend on the build system, of course. What matters is that I run these commands myself and have a tarball at the end.
- Before I actually release that tarball, I run
git push. If there have been any commits since I started, I either have to rebase and update the
NEWSfile, or do some branching. This is fortunately quite rare.
- Also before releasing the tarballs, I tag the release with
git tag -sand push the tag. Importantly, I only do this after pushing the commits, because otherwise if other commits have happened I have to do tag surgery. Nobody likes that.
- Finally, I
scpthe tarball to a GNOME server,
sshinto that server, and run a release script that the release team maintains.
The two things that take the most time are rolling a tarball (which I do at least twice), and creating the
NEWS entry. Rolling tarballs is something that can happen in the background, so I usually have multiple terminal tabs, and I work on other releases while one release is building. So that part isn’t too bad, but sometimes I am just waiting on a build to finish with nothing else to do. I know some people auto-generate
NEWS entries, or don’t write them at all, but I find hand-edited entries extremely valuable. (I do read them when writing help for apps, when I actually find time to do that, so a big thanks to app maintainers who write them.)
I’m tossing around in my head what a more GitLab-focused workflow would look like. I could imagine a workflow where I click a “Release” button, and I get prompted for a version number and a
NEWS entry. I’m not even sure I care if the “news” is in a file in the tarball, as long as I know where to find it. (Distro packagers might feel differently. I don’t know what their processes look like.) I would still need to look at a commit log to write the news. And I guess I’d probably still want to do my own
git status sanity check before going to GitLab, but I could probably catch a lot of that with either CI or local commit checks. Ensuring there are no dist breakages should almost certainly be done on every commit with CI.
I suppose another thing to consider is just maintainers remembering it’s time to make releases. I didn’t miss this one because I was eagerly awaiting playing with it and updating the help, but I’ve missed lots of releases in the past. Could we all get automatic issues added to our todo lists a few days in advance of expected releases? Would that be annoying? I don’t know.
3 thoughts on “Making Releases”
On the python world there is this tool named [towncrier](https://pypi.org/project/towncrier/) that at least would help building the NEWS, and that tied to the gitlab workflow, would mean that any merge request should have its news file entry.
Building the tarballs, I have no idea what involves, but again, with CI pipelines, one can use a docker image with all the tools needed to do so. Actually a coordinated GNOME development docker image, where every new package released gets added, would mean that, if released in the right order, every package could get released and ensure that there is no breakage with the dependencies…
A small correction: the workflow you’re describing (5.) is pre-release version bumps. Post-release version bump is when you bump the version after finishing the release.
As you mentioned, the manual part of the release (writing NEWS) is the hard part (as well as deciding whether or not to squeeze in that last feature/bug fix before release).
Hmm, this terminology is confusing. I see that post-release bump means changing the version right after a release. In my mind, I was thinking of a pre-release bump as something you do well in advance of a release. I guess to me, what I’m doing is really an at-release bump.
Comments are closed.