feat(cmd): add use command

+ small refactoring

Author: markcda

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "deployer"
-version = "2.0.0-beta-6"
+version = "2.0.0-beta-7"
 edition = "2024"
 
 [[bin]]

DOCS.md

@@ -35,7 +35,7 @@ depl watch my-pipe                         # watch `my-pipe` Pipeline and re-run
 
 ### Console Interface (TUI)
 
-Deployer has support for a high-end terminal-based customizer, allowing you to forget about manually writing Actions and Pipelines for your projects. Just try to create an Action or Pipeline and Deployer will ask you about everything.
+Deployer has support for a high-end terminal-based customizer, allowing you to forget about manually writing actions and Pipelines for your projects. Just try to create an action or Pipeline and Deployer will ask you about everything.
 
 ### Logs
 
@@ -47,7 +47,7 @@ In the Deployer build caches folder, there is a `logs` folder that contains proj
 
 Action is the main entity of Deployer. Actions as part of pipelines are used to build, install, and deploy processes. However, an action itself cannot be assigned to a project, that's what pipelines are for (see below).
 
-In the Deployer's Action Registry or project's actions list, an action looks like a construction:
+In the Deployer's action Registry or project's actions list, an action looks like a construction:
 
 ```yaml
 info: upx@0.1.0
@@ -78,7 +78,7 @@ requirements:
   # if this path exists, the requirement is considered satisfied
   - type: exists
     path: /usr/bin/mold
-  # if this check is passed, the requirement will be considered satisfied (for details, see below - Action `Check`)
+  # if this check is passed, the requirement will be considered satisfied (for details, see below - action `Check`)
   - type: check_success
     command:
       cmd: /usr/bin/python -V
@@ -99,7 +99,7 @@ There are 7 action categories:
 6. Actions of synchronization build folders - from current to remote host `sync_to_remote` and vice versa `sync_from_remote`
 7. `interrupt` (when a user needs to perform some actions by hand before continue a pipeline)
 
-The concept of a custom command, a command for the terminal shell, is fundamental. The `custom`, `observe`, and the three main categories of Actions contain one or more custom commands inside.
+The concept of a custom command, a command for the terminal shell, is fundamental. The `custom`, `observe`, and the three main categories of actions contain one or more custom commands inside.
 
 #### 1.1. Custom command
 
@@ -268,7 +268,7 @@ When a patch is applied, Deployer displays the number of times it has been appli
 
 #### 1.4. Actions of synchronization run folders - from current to remote host `sync_to_remote` and vice versa `sync_from_remote`
 
-Sometimes you need to synchronize build files between remote hosts and the current host. For example, when some actions must be performed on one host, and some on another. To do this, you can use the built-in Actions `sync_to_remote` and `sync_from_remote`.
+Sometimes you need to synchronize build files between remote hosts and the current host. For example, when some actions must be performed on one host, and some on another. To do this, you can use the built-in actions `sync_to_remote` and `sync_from_remote`.
 
 #### 1.5. Other actions - `interrupt`, `observe` and `test`
 
@@ -344,9 +344,9 @@ Building and execution occur as follows:
 5. Deployer on the host machine runs Deployer in the container and performs complete pipeline execution.
 
 > [!NOTE]
-> When building in containers, Deployer does not support Actions `interrupt`, `observe`, `add_to_storage` and `use_from_storage`, and when running - Actions `add_to_storage` and `use_from_storage`.
+> When building in containers, Deployer does not support actions `interrupt`, `observe`, `add_to_storage` and `use_from_storage`, and when running - actions `add_to_storage` and `use_from_storage`.
 >
-> To solve problems of synchronizing files or performing I/O operations, you can use a pipeline with containerized build options inside another pipeline, which can then use the Actions you need.
+> To solve problems of synchronizing files or performing I/O operations, you can use a pipeline with containerized build options inside another pipeline, which can then use the actions you need.
 
 > [!NOTE]
 > To prevent building Deployer before your project, switch to `shell` pipeline driver.

MIGRATIONS.md

@@ -20,7 +20,7 @@ Migrations will be applied automatically.
 
 ## From `1.4.1` to `1.4.2`
 
-1. Manually check all your `add_to_storage` Actions (`AutoVersionExtractFromRule`): them now look like this:
+1. Manually check all your `add_to_storage` actions (`AutoVersionExtractFromRule`): them now look like this:
 
 ```json
 [
@@ -57,10 +57,10 @@ Formally, you should now specify `type` field of `auto_version_rule` object.
 
 Migrations will be almost fully applied automatically on configuration save. Deployer will be able to work with old configuration formats (`"version": 2`).
 
-1. All Actions will be typed internally with `type` field and `snake_case` (example: `{ "type": "build", ... }`).
+1. All actions will be typed internally with `type` field and `snake_case` (example: `{ "type": "build", ... }`).
 2. `deploy-config.json` and `deploy-global.json` will be upgraded to `"version": 3`.
 3. Variables, requirements, placements and other structs are changed, see the documentation.
-4. Check Action will become Test, original Test will be migrated into PostBuild.
+4. Check action will become Test, original Test will be migrated into PostBuild.
 
 ### Need manual changes:
 
@@ -74,5 +74,5 @@ Migrations will be almost fully applied automatically on configuration save. Dep
 ## From `<=1.2.1` to `1.3.0`
 
 1. Edit `deploy-config.json` and rename `inplace_artifacts_into_project_root` to `place_artifacts_into_project_root`.
-2. Remove `tags` field inside your deploy-like and `Observe` Actions.
+2. Remove `tags` field inside your deploy-like and `Observe` actions.
 3. `deploy-config.json` and `deploy-global.json` will be upgraded to `"version": 2`.

README.md

@@ -96,7 +96,7 @@ actions:
     used: upx@0.1.0
 ```
 
-Note that you can change the inner content of Actions inside Pipelines, and also can change the inner content of Pipelines and their Actions if these Pipelines assigned to your project. The changes will not affect Actions and Pipelines from Deployer's Registries.
+Note that you can change the inner content of actions inside Pipelines, and also can change the inner content of Pipelines and their actions if these Pipelines assigned to your project. The changes will not affect actions and Pipelines from Deployer's Registries.
 
 You can view your actions and pipelines and get it in YAML by simple commands:
 
@@ -108,7 +108,7 @@ depl cat action upx@0.1.0
 depl cat pipeline pack@0.1.0
 ```
 
-And, of course, load Actions and Pipelines from YAML files by:
+And, of course, load actions and Pipelines from YAML files by:
 
 ```bash
 depl new action -f {your config}
@@ -122,7 +122,7 @@ depl init
 depl edit .
 ```
 
-You should add some actions and specify project variables that you'll use. For our example, add simple variable with `target/release/my-app` value. Also add `cargo-release@0.1.0` and `upx@0.1.0` actions from Actions Registry. And not forget to add `Cargo.lock` file and `target` folder to cache files to prevent syncing project folder cache with run folder cache (without specifying this; see `depl run --help` for more).
+You should add some actions and specify project variables that you'll use. For our example, add simple variable with `target/release/my-app` value. Also add `cargo-release@0.1.0` and `upx@0.1.0` actions from actions Registry. And not forget to add `Cargo.lock` file and `target` folder to cache files to prevent syncing project folder cache with run folder cache (without specifying this; see `depl run --help` for more).
 
 After all you will get this `.depl/config.yaml`:
 
@@ -199,7 +199,7 @@ depl run -fc
 # or explicitly specify the project pipeline's short name - `build-and-compress`
 depl run pack
 
-# create pipeline with `Observe` Action and start development server with auto-rebuild
+# create pipeline with `Observe` action and start development server with auto-rebuild
 depl watch build-and-deploy-devel
 ```
 

TODO.md

@@ -5,11 +5,11 @@
 - [x] Add `depl cd` command to change current directory to one of run directories
 - [x] Make `depl export` command:
   1. [x] for exporting Pipelines to `bash` scripts
-  2. [x] for exporting (and importing with merging) Actions & Pipelines Registries
+  2. [x] for exporting (and importing with merging) actions & Pipelines Registries
   3. [x] for exporting Pipelines to CI/CD (GitHub Actions & GitLab CI) configurations
-- [x] Add `--skip N` argument to skip N Actions inside selected Pipelines, if you exactly know that they have no need to re-run after changes
+- [x] Add `--skip N` argument to skip N actions inside selected Pipelines, if you exactly know that they have no need to re-run after changes
 - [x] Add `--no-clear` argument to disable screen clear on `run`/`watch`
-- [x] Go to more declarative way to define project configuration (ver. 6 & Deployer v2.0)
+- [x] Go to more declarative way to define project configuration (ver. 7 & Deployer v2.0)
   1. [x] Remove targets, programming languages and actions variability
   2. [x] Rename `Actions` & `Pipelines` to `actions` and `pipelines`
   3. [x] Split `configs.rs` to `project.rs` and `globals.rs`
@@ -34,3 +34,4 @@
 - [x] Add `info` field to requirements to inform users about commands or links to install them
 - [x] Unify `edit`, `cat` & `rm` commands behavior
 - [ ] Add possibility to setup variables inside each pipeline independently
+- [x] Add `use` command to synchronize content (with `subfolder` argument)

src/actions.rs

@@ -37,7 +37,7 @@ use crate::rw::read_checked;
 /// Used action.
 #[derive(Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord, Clone)]
 pub struct UsedAction {
-  /// Description of the Action.
+  /// Description of the action.
   #[serde(skip_serializing_if = "Option::is_none")]
   pub title: Option<String>,
   /// Action defined in the project config.
@@ -62,7 +62,7 @@ impl UsedAction {
       ))
   }
 
-  /// Returns mutable slice to all custom commands in this Action.
+  /// Returns mutable slice to all custom commands in this action.
   pub fn commands<'project>(
     &'project self,
     definitions: &'project BTreeSet<DefinedAction>,
@@ -117,7 +117,7 @@ impl PartialOrd for DefinedAction {
 }
 
 impl DefinedAction {
-  /// Returns mutable slice to all custom commands in this Action.
+  /// Returns mutable slice to all custom commands in this action.
   pub fn commands(&self) -> anyhow::Result<Vec<&CustomCommand>> {
     let cmds = match &self.action {
       Action::Interrupt
@@ -225,7 +225,7 @@ pub enum Action {
   /// Action to run tests.
   Test(TestAction),
 
-  /// Action to run observers (`btop`, Jaeger, Prometheus, Grafana, etc.).
+  /// Action to run observers (`btop`, `gdb`, some `docker` containers, foreground benchmarks, Jaeger, Prometheus, Grafana, etc.).
   Observe(ObserveAction),
 
   /// Action to copy content with given info from Deployer's storage.
@@ -239,7 +239,7 @@ pub enum Action {
 }
 
 impl Action {
-  /// Interrupt Action.
+  /// Interrupt action.
   pub fn interrupt() -> anyhow::Result<(bool, Vec<String>)> {
     println!();
     inquire_reorder::Confirm::new(i18n::INTERRUPT)
@@ -249,7 +249,7 @@ impl Action {
     Ok((true, vec![]))
   }
 
-  /// Runs the Action with given project options and run environment.
+  /// Runs the action with given project options and run environment.
   pub async fn run_with(
     &self,
     config: &DeployerProjectOptions,
@@ -316,7 +316,7 @@ impl Action {
   }
 }
 
-/// Prints all available Actions on the screen.
+/// Prints all available actions on the screen.
 pub fn list_actions(globals: &DeployerGlobalConfig) {
   println!("{}", i18n::ACTIONS_AVAILABLE);
 
@@ -347,7 +347,7 @@ fn choose_action<'a>(actions_registry: &'a BTreeSet<DefinedAction>, prompt: &str
     .ok_or(anyhow!("No such action!"))
 }
 
-/// Removes selected Action.
+/// Removes selected action.
 pub fn remove_action(globals: &mut DeployerGlobalConfig, args: RemoveActionArgs) -> anyhow::Result<()> {
   let action = if let Some(info) = args.info {
     let info = info.to_info()?;
@@ -374,7 +374,7 @@ pub fn remove_action(globals: &mut DeployerGlobalConfig, args: RemoveActionArgs)
   Ok(())
 }
 
-/// Adds new Action.
+/// Adds new action.
 pub fn new_action(globals: &mut DeployerGlobalConfig, args: &NewActionArgs) -> anyhow::Result<DefinedAction> {
   if let Some(from_file) = &args.from {
     let action = read_checked::<DefinedAction>(from_file)
@@ -391,7 +391,7 @@ pub fn new_action(globals: &mut DeployerGlobalConfig, args: &NewActionArgs) -> a
   Ok(defined_action)
 }
 
-/// Prints Action as YAML.
+/// Prints action as YAML.
 pub fn cat_action(globals: &DeployerGlobalConfig, args: CatActionArgs) -> anyhow::Result<()> {
   let action = if let Some(info) = args.info {
     let info = info.to_info()?;
@@ -411,7 +411,7 @@ pub fn cat_action(globals: &DeployerGlobalConfig, args: CatActionArgs) -> anyhow
   Ok(())
 }
 
-/// Edits the Action.
+/// Edits the action.
 pub fn edit_action(globals: &mut DeployerGlobalConfig, args: EditActionArgs) -> anyhow::Result<()> {
   let mut action = if let Some(info) = args.info {
     let info = info.to_info()?;

src/actions/storage_add.rs

@@ -1,4 +1,4 @@
-//! AddToStorage Action.
+//! `AddToStorage` action module.
 //!
 //! Based on automatic rule to extract version from project, allows you to
 //! load your artifacts as content to Deployer's storage.

src/actions/storage_use.rs

@@ -1,4 +1,4 @@
-//! Storage use's module.
+//! `UseFromStorage` action module.
 
 use serde::{Deserialize, Serialize};
 use std::path::PathBuf;

src/ansible.rs

@@ -126,7 +126,7 @@ pub fn make_inventory(
   Ok(())
 }
 
-/// Makes Ansible playbook from given Pipeline.
+/// Makes Ansible playbook from given pipeline.
 pub async fn make_playbook(
   config: &DeployerProjectOptions,
   env: &RunEnvironment<'_>,
@@ -232,7 +232,7 @@ pub async fn make_playbook(
   Ok(playbook_name)
 }
 
-/// Runs given Pipeline with Ansible.
+/// Runs given pipeline with Ansible.
 pub async fn execute_pipeline_with_ansible(
   config: &DeployerProjectOptions,
   env: &RunEnvironment<'_>,