Go to file
Wolfgang Bumiller 532d4d3e9a login: bump to 0.1.2-1
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-09-26 14:51:53 +02:00
.cargo move .cargo/config to .cargo/config.toml 2024-06-20 12:29:30 +02:00
proxmox-access-control tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-acme tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-acme-api tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-api-macro api-macro: allow declaring an additional-properties field 2024-09-26 12:47:58 +02:00
proxmox-apt tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-apt-api-types tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-async tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-auth-api tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-borrow tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-client tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-compression tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-config-digest tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-daemon tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-dns-api tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-http tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-http-error tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-human-byte tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-io tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-lang tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-ldap tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-log tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-login login: bump to 0.1.2-1 2024-09-26 14:51:53 +02:00
proxmox-metrics tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-network-api tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-notify tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-openid tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-product-config tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-rest-server tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-router tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-rrd tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-rrd-api-types tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-schema tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-section-config tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-serde tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-shared-cache tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-shared-memory tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-simple-config tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-sortable-macro tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-subscription tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-sys tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-syslog-api tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-systemd tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-tfa tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-time tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-time-api tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-uuid tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
proxmox-worker-task tree-wide: unify workspace inherited attributes 2024-09-20 08:42:45 +02:00
.gitignore git: ignore top level *-deb make target files 2022-08-26 12:18:44 +02:00
build.sh buildsys: add targets for raw installation and sysexts 2024-09-05 14:15:11 +02:00
bump.sh add bump.sh 2022-12-07 10:36:27 +01:00
Cargo.toml add proxmox-rrd-api-types crate - moved out of proxmox-rrd 2024-09-18 15:55:43 +02:00
Makefile buildsys: add a 'make list-packages' target 2024-09-20 08:43:08 +02:00
README.rst readme: update cargo config path 2024-09-20 08:44:19 +02:00
rustfmt.toml bump edition in rustfmt.toml 2022-10-13 15:00:28 +02:00

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

This repository ships with a ``.cargo/config.toml`` 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.

Quickly installing all packages from apt
========================================

To a void too many manual installations when ``mk-build-deps`` etc. fail, a
quick way to install all the main packages of this workspace is to run:

::

    # apt install $(make list-packages)

Steps for Releases
==================

- Run ./bump.sh <CRATE> [patch|minor|major|<VERSION>]
-- Fill out changelog
-- Confirm bump commit
- Build packages with `make <crate>-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
      edition.workspace = true
      exclude.workspace = true
      homepage.workspace = true
      license.workspace = true
      repository.workspace = true
      rust-version.workspace = true
    If a separate 'exclude' is need it, separate it out as its own block  above
    the inherited fields.
  - 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