Go to file
Wolfgang Bumiller 1d6174d36d bump proxmox-apt to 0.10.7-1
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2023-12-06 15:59:59 +01:00
.cargo cargo: switch to use packaged crates by default 2020-01-03 09:39:52 +01:00
proxmox-acme bump proxmox-acme to 0.5.0 2023-12-04 11:47:28 +01:00
proxmox-api-macro api-macro: make skip_serializing_if without default an error 2023-12-06 14:39:47 +01:00
proxmox-apt bump proxmox-apt to 0.10.7-1 2023-12-06 15:59:59 +01:00
proxmox-async async: runtime: Modernise module and update docs 2023-08-23 09:51:52 +02:00
proxmox-auth-api bump proxmox-auth-api to 0.3.2 2023-11-27 14:46:59 +01:00
proxmox-borrow update d/copyright files to debian copyright-format 1.0 2023-05-23 13:02:39 +02:00
proxmox-client bump proxmox-client to 0.3.0-1 2023-10-16 13:27:13 +02:00
proxmox-compression bump proxmox-compression to 0.2.1-1 2023-06-15 11:01:19 +02:00
proxmox-http http: rate limited stream: fix typo in rustdoc comment 2023-11-08 09:56:26 +01:00
proxmox-http-error more import cleanups 2023-07-28 11:47:39 +02:00
proxmox-human-byte human-byte: d/control bump 2023-10-16 13:04:48 +02:00
proxmox-io proxmox-io: fix sparse_copy not copying sparsely on irregular read operations 2023-08-09 12:48:04 +02:00
proxmox-lang update d/copyright files to debian copyright-format 1.0 2023-05-23 13:02:39 +02:00
proxmox-ldap bump proxmox-ldap to 0.2.1-1 2023-08-08 14:09:19 +02:00
proxmox-login client/login: clippy fixes 2023-08-22 10:04:16 +02:00
proxmox-metrics bump proxmox-metrics to 0.3.0-1 2023-05-23 13:02:51 +02:00
proxmox-notify notify: bump version to 0.3.0-1 2023-11-17 13:36:55 +01:00
proxmox-openid clippy fix: unnecessary use of to_string 2023-08-08 11:29:36 +02:00
proxmox-rest-server bump rest-server to 0.5.1-1 2023-11-28 11:34:54 +01:00
proxmox-router router: fix warning 2023-12-06 14:39:47 +01:00
proxmox-schema bump schema to 2.0.2-1 2023-11-23 09:16:46 +01:00
proxmox-section-config bump proxmox-section-config to 2.0.0-1 2023-07-24 11:03:15 +02:00
proxmox-serde clippy fix: the borrowed expression implements the required traits 2023-08-08 11:05:20 +02:00
proxmox-shared-memory bump proxmox-shared-memory to 0.3.0-1 2023-05-23 13:02:51 +02:00
proxmox-sortable-macro bump proxmox-sortable-macro to 0.1.3-1 2023-10-03 09:37:01 +02:00
proxmox-subscription subscription: update d/control 2023-11-27 14:08:18 +01:00
proxmox-sys sys: bump to 0.5.2-1 2023-11-29 15:26:21 +01:00
proxmox-tfa tfa: fix deserialize-default in TfaUser 2023-12-06 14:54:47 +01:00
proxmox-time DailyDuration: derive PartialEq (for GUI) 2023-10-20 12:01:27 +02:00
proxmox-uuid update d/copyright files to debian copyright-format 1.0 2023-05-23 13:02:39 +02:00
.gitignore move to proxmox-acme 2023-12-04 11:41:59 +01:00
build.sh build.sh: split overly long line 2023-06-03 16:48:10 +02:00
bump.sh add bump.sh 2022-12-07 10:36:27 +01:00
Cargo.toml add proxmox-acme to workspace 2023-12-04 11:45:00 +01:00
Makefile move to proxmox-acme 2023-12-04 11:41:59 +01:00
README.rst update README 2023-08-01 15:48:19 +02:00
rustfmt.toml move to proxmox-acme 2023-12-04 11:41:59 +01: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
==================

- Run ./bump.sh <CRATE> [patch|minor|major|<VERSION>]
-- Fill out changelog
-- Confirm bump commit
- Build packages with `make deb`.
-- Don't forget to commit updated d/control!

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

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

2) In the new crate's ``Cargo.toml``:
  - In ``[package]`` set:
      authors.workspace = true
      license.workspace = true
      edition.workspace = true
      exclude.workspace = true
      repository.workspace = true
  - Add a meaningful ``description``
  - Copy ``debian/copyright`` and ``debian/debcargo.toml`` from another subcrate.

Adding a new Dependency
=======================

1) At the top level:
  - Add it to ``[workspace.dependencies]`` specifying the version and any
    features that should be enabled throughout the workspace

2) In each member's ``Cargo.toml``:
  - Add it to the desired dependencies section with ``workspace = true`` and no
    version specified.
  - If this member requires additional features, add only the extra features to
    the member dependency.

Updating a Dependency's Version
===============================

1) At the top level:
  - Bump the version in ``[workspace.dependencies]`` as desired.
  - Check for deprecations or breakage throughout the workspace.

Notes on Workspace Inheritance
==============================

Common metadata (like authors, license, ..) are inherited throughout the
workspace. If new fields are added that are identical for all crates, they
should be defined in the top-level ``Cargo.toml`` file's
``[workspace.package]`` section, and inherited in all members explicitly by
setting ``FIELD.workspace = true`` in the member's ``[package]`` section.

Dependency information is also inherited throughout the workspace, allowing a
single dependency specification in the top-level Cargo.toml file to be used by
all members.

Some restrictions apply:
- features can only be added in members, never removed (this includes
  ``default_features = false``!)
 - the base feature set at the workspace level should be the minimum (possibly
   empty!) set required by all members
- workspace dependency specifications cannot include ``optional``
 - if needed, the ``optional`` flag needs to be set at the member level when
   using a workspace dependency