Release process checklist
Feel free to print this document or copy it to a text editor to check off items while making a release.
☐ Refresh your memory with https://wiki.gnome.org/MaintainersCorner/Releasing
☐ Increase the package version number in
configure.ac(it may already be increased but not released; double-check it).
☐ Copy version number to
☐ Copy version number to
☐ Compute and write version number to
rsvg/Cargo.toml, see crate version below.
☐ Copy the crate version number to the example in rsvg/src/lib.rs.
cargo update- needed because you tweaked
Cargo.toml, and also to get new dependencies.
☐ Tweak the library version number in
configure.acif the API changed; follow the steps there.
NEWS, see below for the preferred format.
☐ Commit the changes above; push a branch.
☐ Create a merge request; fix it until it passes the CI. Merge it.
cargo publish -p librsvg, see Releasing to crates.io for details.
☐ If this is a development release, create a signed tag for the crate’s version -
git tag -s x.y.z-beta.w.
☐ Create a signed tag for the merge commit -
git tag -s x.y.zwith the version number.
☐ If this is a development release
git pushthe signed tag for the crate’s version to gitlab.gnome.org/GNOME/librsvg
git pushthe signed tag for the GNOME version to gitlab.gnome.org/GNOME/librsvg
☐ Go to the merge request’s pipeline, and look for the
distcheckjob. That one has the release tarball; download it.
☐ Copy that tarball to the FTP staging server:
scp librsvg-x.y.z.tar.xz master.gnome.org:
ssh master.gnome.organd then
ftpadmin install librsvg-x.y.z.tar.xz
☐ Create a release in Gitlab.
x.y.0 releases, do the following:
☐ Notify the release team on whether to use this
librsvg-x.y.0for the next GNOME version via an issue on their
cargo-audit auditand ensure we don’t have vulnerable dependencies.
☐ Go to https://gitlab.gnome.org/GNOME/librsvg/-/releases and click the New release button.
☐ Select the tag
x.y.zyou created as part of the release steps.
☐ If there is an associated milestone, select it too.
☐ Fill in the release title -
☐ Copy the release notes from NEWS.
☐ Add a release asset link to
https://download.gnome.org/sources/librsvg/x.y/librsvg-x.y.z.tar.xzand call it
librsvg-x.y.z.tar.xz - release tarball.
☐ Add a release asset link to
https://download.gnome.org/sources/librsvg/x.y/librsvg-x.y.z.sha256sumand call it
librsvg-x.y.z.sha256sum - release tarball sha256sum.
Version numbers and release schedule
Cargo.toml must have the same package
version number - this is the number that users of the library see.
configure.ac is where the library version is defined; this is
what gets encoded in the SONAME of
Librsvg follows GNOME’s release versioning as of 2022/September. (Note that it used an even/odd numbering scheme before librsvg 2.55.x)
Librsvg follows GNOME’s six-month release schedule.
needs to be notified when a new series comes about, so they can adjust
their tooling for the stable GNOME releases. File an
issue in their repository to indicate that
librsvg-x.y.0 is a stable series.
Version number for public Rust crate
librsvg crate is available on crates.io. This is for people who wish to
use librsvg directly from Rust, instead of via the C ABI library
While the C ABI library uses the GNOME versioning scheme, Rust crates use SemVer. So, for librsvg, we have the following scheme:
GNOME tarball: 2.57.0
Rust crate: 2.57.0 (i.e. the same)
GNOME tarball: 2.57.90 through 2.57.99 (.9x patch version means development release)
Rust crate: 2.58.0-beta.0 through -beta.9 (SemVer supports a -beta.x suffix)
When making releases, you have to edit
rsvg/Cargo.toml by hand to put in version numbers like the above.
The CI scripts will check that the correct versions are in place.
Releasing to crates.io
After preparing a GNOME release, you’ll also want to release to
crates.io. This requires an API token;
if you are maintainer you should have one, and also write access to
librsvg crate on crates.io.
To make a release,
cargo publish -p librsvg.
After this succeeds, proceed with the rest of the steps in the ref:release_process_checklist.
Minimum supported Rust version (MSRV)
While it may seem desirable to always require the latest released version of the Rust toolchain, to get new language features and such, this is really inconvenient for distributors of librsvg which do not update Rust all the time. So, we make a compromise.
configure.ac script defines
MINIMUM_RUST_MINOR variables with librsvg’s minimum supported Rust
version (MSRV). These ensure that distros will get an early failure
during a build, at the
configure step, if they have a version of
Rust that is too old — instead of getting an obscure error message from
rustc in the middle of the build when it finds an unsupported
Please update all of these values when increasing the MSRV:
Sometimes librsvg’s dependencies update their MSRV and librsvg may need to increase it as well. Please consider the following before doing this:
Absolutely do not require a nightly snapshot of the compiler, or crates that only build on nightly.
Distributions with rolling releases usually keep their Rust toolchains fairly well updated, maybe not always at the latest, but within two or three releases earlier than the latest. If the MSRV you want is within about six months of the latest, things are probably safe.
Enterprise distributions update more slowly. It is useful to watch for the MSRV that Firefox requires, although sometimes Firefox updates Rust very slowly as well. Now that distributions are shipping packages other than Firefox that require Rust, they will probably start updating more frequently.
Generally — two or three releases earlier than the latest stable Rust is OK for rolling distros, probably perilous for enterprise distros. Releases within a year of an enterprise distro’s shipping date are probably OK.
If you are not sure, ask on the forum for GNOME
their plans! (That is, posts on
discourse.gnome.org with the
Format for release notes in NEWS
NEWS file contains the release notes. Please use something
close to this format; it is not mandatory, but makes the formatting
consistent, and is what tooling expects elsewhere - also by writing
Markdown, you can just cut&paste it into a Gitlab release. You can skim
bits of the
NEWS file for examples on style and content.
New entries go at the top of the file.
Commentary on the release; put anything here that you want to
highlight. Note changes in the build process, if any, or any other
things that may trip up distributors.
## Description of a special feature
You can include headings with `##` in Markdown syntax.
Blah blah blah.
Next is a list of features added and issues fixed; use gitlab's issue
numbers. I tend to use this order: first security bugs, then new
features and user-visible changes, finally regular bugs. The
rationale is that if people stop reading early, at least they will
have seen the most important stuff first.
- #123 - title of the issue, or short summary if it warrants more
discussion than just the title.
- #456 - fix blah blah (Contributor's Name).
## Special thanks for this release:
- Any people that you want to highlight. Feel free to omit this
section if the release is otherwise unremarkable.
Making a tarball
make distcheck DESTDIR=/tmp/foo
DESTDIR is a quirk, required because otherwise the gdk-pixbuf
loader will try to install itself into the system’s location for pixbuf
loaders, and it won’t work. The
DESTDIR is what Linux distribution
packaging scripts use to
make install the compiled artifacts to a
temporary location before building a system package.
Copying the tarball to master.gnome.org
Librsvg’s Cargo.lock is checked into git because the resolved versions of crates that it mentions are the ones that were actually used to run the test suite automatically in CI, and are “known good”. In other words: keep the results of dependency resolution in version control, and update those results manually.
It is important to keep these dependencies updated; you can do that
regularly with the
cargo update step listed in the checklist
cargo-audit is very useful to
scan the list of dependencies for registered vulnerabilities in the
RustSec vulnerability database. Run it
especially before making a new
x.y.0 release, or check the output
deny job in CI pipelines — this runs cargo-deny to check for
vulnerable and duplicate dependencies.
Sometimes cargo-audit will report crates that are not vulnerable, but that are unmaintained. Keep an eye of those; you may want to file bugs upstream to see if the crates are really unmaintained or if they should be substituted for something else.
Creating a stable release branch
Create a branch named
ci/container-builds.ymlrefer to the new
librsvg-xx.yybranch instead of
Push that branch to origin.
(Branches with that naming scheme are already automatically protected in gitlab’s Settings/Repository/Protected branches.)
Edit the badge for the stable branch so it points to the new branch: Settings/General/Badges, find the existing badge for the stable branch, click on the edit button that looks like a pencil. Change the Link and Badge image URL; usually it is enough to just change the version number in both.