Giter Club home page Giter Club logo

proxmox-rs's Introduction

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> [patchmajor|<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

proxmox-rs's People

Contributors

aaronlauterer avatar aequitosh avatar blub avatar cebner-proxmox avatar christoph-heiss avatar fabian-gruenbichler avatar flumm avatar foxmox avatar hannes99 avatar j0ru avatar kaffarell avatar lwagner94 avatar maurerdietmar avatar pimaker avatar puffi avatar thomaslamprecht avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.