Go to file
Wolfgang Bumiller 17adc570db bump proxmox-borrow to 1.0.1-1
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2021-10-13 10:41:01 +02:00
.cargo cargo: switch to use packaged crates by default 2020-01-03 09:39:52 +01:00
proxmox update proxmox crate to the current split 2021-10-11 12:34:14 +02:00
proxmox-api-macro bump proxmox-api-macro to 1.0.1-1 2021-10-12 14:51:35 +02:00
proxmox-borrow bump proxmox-borrow to 1.0.1-1 2021-10-13 10:41:01 +02:00
proxmox-http update proxmox-http to 0.5 for the split 2021-10-11 12:34:14 +02:00
proxmox-io add proxmox-io crate 2021-10-11 10:07:53 +02:00
proxmox-lang lang: prepare c_str for const fns with 1.56 2021-10-12 14:29:03 +02:00
proxmox-router add proxmox-schema and proxmox-router crates 2021-10-11 11:39:59 +02:00
proxmox-schema add proxmox-schema and proxmox-router crates 2021-10-11 11:39:59 +02:00
proxmox-section-config add proxmox-section-config crate 2021-10-11 11:39:59 +02:00
proxmox-sortable-macro update versions in generated control files 2021-07-20 15:45:45 +02:00
proxmox-tfa add proxmox-tfa crate 2021-10-08 15:22:17 +02:00
proxmox-time add proxmox-time crate 2021-10-08 15:22:17 +02:00
proxmox-uuid add proxmox-uuid crate 2021-10-08 15:22:17 +02:00
.gitignore ignore member crate target dirs as well 2021-02-03 11:18:34 +01:00
build.sh build: track d/control in git 2020-11-30 15:13:01 +01:00
Cargo.toml add proxmox-section-config crate 2021-10-11 11:39:59 +02:00
Makefile add proxmox-section-config crate 2021-10-11 11:39:59 +02:00
README.rst start checklist for adding crates in README.rst 2021-10-06 10:37:17 +02:00
rustfmt.toml initial import, starting with vec & io helpers 2019-06-06 14:00:25 +02:00

Local cargo config
==================

This repository ships with a ``.cargo/config`` that replaces the crates.io
registry with packaged crates located in ``/usr/share/cargo/registry``.

A similar config is also applied building with dh_cargo. Cargo.lock needs to be
deleted when switching between packaged crates and crates.io, since the
checksums are not compatible.

To reference new dependencies (or updated versions) that are not yet packaged,
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`.

Adding Crates
=============

1) At the top level:
  - Generate the crate: ``cargo new --lib the-name``
  - Sort the crate into ``Cargo.toml``'s ``workspace.members``
  - Sort the crate into the ``Makefile``'s ``CRATES`` list.

2) In the new crate's ``Cargo.toml``:
  - Replace the ``author`` line with
    ``authors = ["Proxmox Support Team <support@proxmox.com>"]``
  - Add ``license = "AGPL-3"``
  - Add ``exclude = [ "debian" ]``
  - Add a meaningful ``description``
  - Copy ``debian/copyright`` and ``debian/debcargo.toml`` from another subcrate.