Tshepang Mbambo, Christian Poveda Ruiz
Feb 8, 2024
Bindgenis an important tool for helping to accelerate the transition from C and C++ to Rust because it generates FFI bindings. We knew that improving the robustness ofbindgenwould advance our efforts of bringing memory safety to critical infrastructure. We've been working with Ferrous Systems to make improvements tobindgen. This post summarizes their most recent work.
Ferrous Systems maintained bindgen through the end of 2023, and we're excited to share an update on our contributions to this project.
Our plan has always been to hand the project back to its original maintainer, so we decided to focus on easing the maintenance of the project instead of adding new features. We made several improvements to the documentation (2607, 2613, 2615 and 2634), and fixed small bugs that were introduced in some of the restructuring work we did in the past (2614, 2621, 2625, 2629, 2633, 2637, 2648 and 2676).
However, our most relevant contribution to the project is a complete overhaul of the release process of bindgen.
Automated releases
Bindgen does not stick to a periodic release schedule; instead, releases are done when users need a specific feature that has not been released yet. This motivated us to make the release process as easy and short as possible.
Creating a new release previously consisted of the following steps:
Ensure that all the changes done to the project's API since the last release are included in the unreleased section of the changelog
Move all the changes in the unreleased section of the changelog to the new version's section
Update the table of contents of the changelog using
doctocBump the version of the
bindgenandbindgen-clicratesPublish a new version of both crates in
crates.ioGenerate a new git tag with the same commit published in
crates.ioCreate a new Github release pointing to this tag
Although most of these steps were not difficult, they took more than a few minutes to complete and forced the maintainer to go back and forth between windows to remember the next step each time. However, the only step that requires human intervention is updating the changelog. The rest is something that a machine with a long enough strip of tape and a good table of rules could do.
Luckily for us, there are already some excellent tools in the Rust ecosystem focused on releasing and distributing software.
First we have cargo-release, which allows us to automatically bump the version of the crates, create the git tag and publish the crates to crates.io. It also has this neat feature of running hooks before the release is done, which we used to update the sections and table of contents of the changelog automatically.
Then we have cargo-dist, which is able to create binaries and installers, and also generate Github releases automatically.
This means that not only were we able to automate most of the release process, but we were also able to produce binary releases so users no longer have to compile bindgen-cli themselves every time a new version of bindgen is released.
We didn't get this process right initially. It required a couple of iterations and we even botched one release in the process.
As an aside, it was lovely to see the axodotdev team, who are behind cargo-dist, celebrate the news that the (grand old) bindgen project is benefitting from the fruits of their labor.
What's next?
With our Prossimo contract ending in 2023, we handed back complete maintenance of bindgen to its original maintainer, Emilio. We would like to thank Prossimo for the opportunity, as well as Emilio for trusting us to help maintain the project.