| 1 |
# dbus release checklist |
| 2 |
|
| 3 |
To make a release of D-Bus, do the following: |
| 4 |
|
| 5 |
- check out a fresh copy from Git |
| 6 |
|
| 7 |
- verify that the libtool versioning/library soname in `meson.build` is |
| 8 |
changed if it needs to be, or not changed if not |
| 9 |
- CMake takes the version number from `meson.build` and so should not |
| 10 |
need updating |
| 11 |
|
| 12 |
- update the file NEWS based on the git history |
| 13 |
|
| 14 |
- verify that the version number of dbus-specification.xml is |
| 15 |
changed if it needs to be; if changes have been made, update the |
| 16 |
release date in that file |
| 17 |
|
| 18 |
- update the AUTHORS file with |
| 19 |
`ninja -C ${builddir} maintainer-update-authors` |
| 20 |
if necessary |
| 21 |
|
| 22 |
- the version number in `meson.build` should have major.minor.micro, even |
| 23 |
if micro is 0, i.e. "1.0.0" and "1.2.0" not "1.0"/"1.2"; the micro |
| 24 |
version should be even for releases, and odd for intermediate snapshots |
| 25 |
- CMake takes the version number from `meson.build` and so should not |
| 26 |
need updating |
| 27 |
|
| 28 |
- When ready to release, `git commit -a`. This is the version |
| 29 |
of the tree that corresponds exactly to the released tarball. |
| 30 |
|
| 31 |
- `meson dist -C ${builddir)` |
| 32 |
(this is the equivalent of Autotools `make distcheck`) |
| 33 |
|
| 34 |
- if `meson dist` failed, fix it, commit, retry until successful |
| 35 |
|
| 36 |
- tag the tree with `git tag -s -m 'Released X.Y.Z' dbus-X.Y.Z` |
| 37 |
where X.Y.Z is the version of the release. If you can't sign |
| 38 |
then simply created an unsigned annotated tag: |
| 39 |
`git tag -a -m 'Released X.Y.Z' dbus-X.Y.Z`. |
| 40 |
|
| 41 |
- bump the version number up in `meson.build` |
| 42 |
again (so the micro version is odd), |
| 43 |
and commit it. Make sure you do this *after* tagging the previous |
| 44 |
release! The idea is that git has a newer version number |
| 45 |
than anything released. Similarly, bump the version number of |
| 46 |
dbus-specification.xml and set the release date to "(not finalized)". |
| 47 |
|
| 48 |
- push your changes and the tag to the central repository with |
| 49 |
`git push --atomic origin main dbus-X.Y dbus-X.Y.Z` |
| 50 |
|
| 51 |
- scp your tarball to freedesktop.org server and copy it to |
| 52 |
`dbus.freedesktop.org:/srv/dbus.freedesktop.org/www/releases/dbus/`. |
| 53 |
This should be possible if you're in group "dbus" |
| 54 |
|
| 55 |
- Update the online documentation with |
| 56 |
`ninja -C ${builddir} maintainer-upload-docs`. |
| 57 |
|
| 58 |
- If `doc/busconfig.dtd` and/or `doc/introspect.dtd` have changed, send |
| 59 |
a merge request to `xdg-specs` similar to |
| 60 |
<https://gitlab.freedesktop.org/xdg/xdg-specs/90> to get the new |
| 61 |
version published |
| 62 |
|
| 63 |
- post to [email protected] announcing the release. |
| 64 |
|
| 65 |
## Making a ".0" stable release |
| 66 |
|
| 67 |
We create a branch for each stable release. The branch name should be |
| 68 |
dbus-X.Y which is a branch that has releases versioned X.Y.Z; |
| 69 |
changes on a stable branch should be limited to significant bug fixes. |
| 70 |
|
| 71 |
Because we won't make minor changes like keeping up with the latest |
| 72 |
deprecations on a stable branch, stable branches should turn off the |
| 73 |
gcc warning for deprecated declarations (e.g. see commit 76a68867). |
| 74 |
|
| 75 |
Be extra-careful not to merge main (or any branch based on main) into a |
| 76 |
stable branch. |
| 77 |
|
| 78 |
To branch: |
| 79 |
|
| 80 |
git branch dbus-X.Y |
| 81 |
|
| 82 |
and upload the branch tag to the server: |
| 83 |
|
| 84 |
git push origin dbus-X.Y |
| 85 |
|
| 86 |
To develop in this branch: |
| 87 |
|
| 88 |
git checkout dbus-X.Y |
| 89 |
|
| 90 |
After starting a new stable branch: |
| 91 |
|
| 92 |
- update the wiki page <https://www.freedesktop.org/wiki/Software/dbus> by |
| 93 |
adding the new release under the Download heading |