Expand description
§Module :: cargo_will
Utility to publish multi-crate and multi-workspace environments and maintain their consistency.
§Purpose
-
Multi-Workspace Consistency: In a project setup involving multiple workspaces with shared dependencies,
willbe
maintains consistency. It ensures all workspaces are updated with compatible dependency versions. -
Publishing Multi-Crate Projects: If your project structure includes multiple crates that need simultaneous publishing,
willbe
manages the process seamlessly. It ensures the crates are published in the right order while staying in version sync. -
Dependency Analysis:
willbe
can perform a thorough analysis of your project’s dependencies, providing a detailed highlight of inconsistencies or areas that need attention. -
Test Execution With Varied Configurations:
willbe
can execute tests with varying configurations, such as different combinations of crate features. This assists in ensuring comprehensive coverage of test scenarios. -
Generate Health Table: Quickly visualize important project metrics like build status for each crate, creating a single, easy-to-read table.
-
Automating CI/CD Workflow Generation: Automatically generate a series of CI/CD operations suitable for the task at hand to enhance productivity and improve the development process.
§To install
cargo install cargo_will
will .
§Try out from the repository
git clone https://github.com/Wandalen/wTools
cd wTools/module/alias/cargo_will
cargo install --path .
will .
Modules§
- action
- Describes functions that can be called from an interface.
- command
- Describes CLI commands.
- entity
- Entities of which spaces consists of.
- exposed
- Exposed namespace of the module.
- orphan
- Orphan namespace of the module.
- prelude
- Prelude to use essentials:
use my_module::prelude::*
. - protected
- Protected namespace of the module.
- tool
- Genera-purpose tools which might be moved out one day.
- wtools
- Micro wtools
Structs§
- Crate
Dir - Path to crate directory
- Manifest
- Hold manifest data.
- Workspace
- Stores information about current workspace.
Functions§
- run
- Takes the command line arguments and perform associated function(s). If no arguments are provided, the function identifies this as an ambiguous state and prompts the user with a help message, suggesting possible commands they might want to execute. It then terminates the program with an exit code of 1 to indicate an error due to the lack of input.
- test
- run tests in specified crate
- workflow_
renew - Generate table.
- workspace_
renew - Create new workspace.