libdrm: NOTE! Default branch is now main
[drm/libdrm.git] / RELEASING
blob903c1761d41f928d524558ba4daf03452b4f8837
1 The release criteria for libdrm is essentially "if you need a release,
2 make one".  There is no designated release engineer or maintainer.
3 Anybody is free to make a release if there's a certain feature or bug
4 fix they need in a released version of libdrm.
6 When new ioctl definitions are merged into drm-next, we will add
7 support to libdrm, at which point we typically create a new release.
8 However, this is up to whoever is driving the feature in question.
10 Follow these steps to release a new version of libdrm:
12   1) Bump the version number in meson.build. We seem to have settled for
13      2.4.x as the versioning scheme for libdrm, so just bump the micro
14      version.
16   2) Run `ninja -C builddir/ dist` to generate the tarballs.
17      Make sure that the version number of the tarball name in
18      builddir/meson-dist/ matches the number you bumped to. Move that
19      tarball to the libdrm repo root for the release script to pick up.
21   3) Push the updated master branch with the bumped version number:
23         git push origin master
25      assuming the remote for the upstream libdrm repo is called origin.
27   4) Use the release.sh script from the xorg/util/modular repo to
28      upload the tarballs to the freedesktop.org download area and
29      create an announce email template.  The script takes one argument:
30      the path to the libdrm checkout. So, if a checkout of modular is
31      at the same level than the libdrm repo:
33         ./modular/release.sh libdrm
35      This copies the two tarballs to freedesktop.org and creates
36      libdrm-2.4.16.announce which has a detailed summary of the
37      changes, links to the tarballs, MD5 and SHA1 sums and pre-filled
38      out email headers.  Fill out the blank between the email headers
39      and the list of changes with a brief message of what changed or
40      what prompted this release.  Send out the email and you're done!