README: Remove 'Versioning', add 'Steps for Releases'

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2020-01-15 14:26:06 +01:00
parent f22b693800
commit b9e7824bd3

View File

@ -1,23 +1,3 @@
Versioning
==========
Note that the following applies *per crate*, since each crate is its own debian package:
The first commit after a release should bump the version to the next patch level with a ``-dev.1``
suffix for the crate *and for the proxmox crate*, as well as all crates depending on it. For
instance, ``proxmox-api`` depends on ``proxmox-tools``, so bumpgin ``proxmox-tools`` to a new `dev`
version also requires bumping ``proxmox-api`` to a new dev version, since cargo requires
pre-release versions to be selected explicitly:
First commit after release: 0.1.0 -> 0.1.1-dev.1
Version bump commit: 0.1.1-dev.1 -> 0.1.1
It is unlikely that we'll need more than one .dev version, but it may be useful at some point, so
we'll include teh ``.1``.
When releasing a crate, the final commit should be the one stripping the ``-dev`` version and
updating the ``debian/changelog``.
Local cargo config Local cargo config
================== ==================
@ -30,3 +10,13 @@ checksums are not compatible.
To reference new dependencies (or updated versions) that are not yet packaged, To reference new dependencies (or updated versions) that are not yet packaged,
the dependency needs to point directly to a path or git source. the dependency needs to point directly to a path or git source.
Steps for Releases
==================
- Cargo.toml updates:
- Bump all modified crate versions.
- Update all the other crates' Cargo.toml to depend on the new versions if
required, then bump their version as well if not already done.
- Update debian/changelog files in all the crates updated above.
- Build packages with `make deb`.