aspera-cli 4.25.0.pre → 4.25.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412bbcc21114ffbdc44a31e61c2f666e1444a61d991ed8cbc0eff52ffcb43381
-  data.tar.gz: 3a1a191e2e05743c2e800902c17f6637181e4bcd2f8b34bec570ffa24b7913b7
+  metadata.gz: 7e017349a111f8385f64794641aed296960fd8cd69bcfcf62110b99c102425c6
+  data.tar.gz: 15fb922208d24921bfbdd352d26b6085addf93231044318e942c7f0df67e4eea
 SHA512:
-  metadata.gz: 7c650e9c2cd0c1a9bf2f264b88464bd148e14acb45bed85f87752146ad91735812c00173dc1dcdb3fe0bfcf7e9ad58362c9a5fed209559be28a545aba8d4f639
-  data.tar.gz: '088400cc458134f6ca68f996e598ad6af70f57bf776de8eadd7687d2b47db805b5e8c91f84beb05c208619f25fb09191b99f0068f13e2d29379d2bd693dacb99'
+  metadata.gz: a6ed834dce6f0991bf9c1a2c2c16b9c8d8224961b4c6cf453a3873d1fba1378bf3a1e825351f7b4dc349ac1e9cc325a0b47c2bd25dc9e6c23ecc8cd140ba0e09
+  data.tar.gz: cd07513558920ae564bbae2da2441d1173a05700ed2dbaa9a6edbd8b17fffe0eec79b48dbe76b63438d97f870bc1113b247f65c861000f0f967dcca1a290a37c

data/CHANGELOG.md

@@ -10,7 +10,8 @@ Released: [Place date of release here]
 
 * **global**: All `Hash` and `Array` options are now cumulative (merged). Value `@none:` resets to empty value.
 * **global**: Improved error diagnostic during evaluation of extended value.
-* **global**: New Extended value modifier: `@:` (empty modifier) to evaluate remaining arguments as `Hash` or `Array`.
+* **global**: New extended value modifier: `@:` (empty modifier) to evaluate remaining arguments as `Hash` or `Array`.
+* **global**: New extended value modifier: `@stdin:chomp` reads stdin and removes `\n`.
 * `config`: New option: `parser` allows definition of default parser for extended values when expecting a `Hash` or `Array` type.
 * `orchestrator`: Commands now takes option `query`.
 
@@ -21,13 +22,15 @@ Released: [Place date of release here]
 
 ### Breaking Changes
 
+* `aoc`: Option `package_folder` is now a Hash instead of formatted String.
 * `server`: By default, SSH option `use_agent` is now `false`.
 * `config`: Removed option `use_product`, replaced with prefix `product:` of option `ascp_path`.
 * `faspex5`: Removed deprecated (4.18) command in `admin`: `resource`, use resource name as command directly in `admin`.
-* `preview`: Replace gem `mimemagic` with `marcel`.
-* PDF manual is now generated for [releases](https://github.com/IBM/aspera-cli/releases) only.
+* `preview`: Replaced gem `mimemagic` with `marcel`.
+* **global**: Extended value modifier `@stdbin:` is replaced with `@stdin:bin`.
+* Build system uses now `rake` instead of `make` for easier portability on Windows.
+* PDF manual removed from repo, it is now generated for [releases](https://github.com/IBM/aspera-cli/releases) only.
 * HTML manual is not generated anymore.
-* Build system uses now `rake` instead of `make` for easier portability with Windows.
 
 ## 4.24.2
 
@@ -36,7 +39,7 @@ Released: 2025-10-24
 ### New Features
 
 * `direct`: Capability to send management messages to `ascp` on running sessions. e.g. change target rate.
-* `config`: Added command: `sync spec` to get sync parameters documentation. Also added to manual.
+* `config`: Added command: `sync spec` to get sync parameters' documentation. Also added to manual.
 
 ### Issues Fixed
 
@@ -309,17 +312,17 @@ Released: 2024-07-13
 * `config`: Command `remote_certificate` now takes a subcommand.
 * **global**: Moved a few internal classes in new/renamed modules
 * **global**: Deprecated pseudo transfer specification parameters starting with `EX_`:
-  * `EX_ssh_key_paths`. Use spec `ssh_private_key` or option `transfer_info={"ascp_args":["-i","..."]}`
-  * `EX_http_proxy_url`. Use option `transfer_info={"ascp_args":["-x","..."]}`
-  * `EX_http_transfer_jpeg`. Use option `transfer_info={"ascp_args":["-j","1"]}`
-  * `EX_no_read`. Use option `transfer_info={"ascp_args":["--no-read"]}`
-  * `EX_no_write`. Use option `transfer_info={"ascp_args":["--no-write"]}`
-  * `EX_file_list`. Use `ascli` file list feature or option `transfer_info={"ascp_args":["--file-list","..."]}`
-  * `EX_file_pair_list`. Use `ascli` file list feature or option `transfer_info={"ascp_args":["--file-pair-list","..."]}`
-  * `EX_ascp_args`. Use option `transfer_info={"ascp_args":[...]}`
-  * `EX_at_rest_password`. Use spec parameter `content_protection_password`
-  * `EX_proxy_password`. Set password in spec parameter `proxy` or use env var `ASPERA_PROXY_PASS`.
-  * `EX_license_text`. Use env var `ASPERA_SCP_LICENSE`.
+  * `EX_ssh_key_paths`: Use spec `ssh_private_key` or option `transfer_info={"ascp_args":["-i","..."]}`
+  * `EX_http_proxy_url`: Use option `transfer_info={"ascp_args":["-x","..."]}`
+  * `EX_http_transfer_jpeg`: Use option `transfer_info={"ascp_args":["-j","1"]}`
+  * `EX_no_read`: Use option `transfer_info={"ascp_args":["--no-read"]}`
+  * `EX_no_write`: Use option `transfer_info={"ascp_args":["--no-write"]}`
+  * `EX_file_list`: Use `ascli` file list feature or option `transfer_info={"ascp_args":["--file-list","..."]}`
+  * `EX_file_pair_list`: Use `ascli` file list feature or option `transfer_info={"ascp_args":["--file-pair-list","..."]}`
+  * `EX_ascp_args`: Use option `transfer_info={"ascp_args":[...]}`
+  * `EX_at_rest_password`: Use spec parameter `content_protection_password`
+  * `EX_proxy_password`: Set password in spec parameter `proxy` or use env var `ASPERA_PROXY_PASS`.
+  * `EX_license_text`: Use env var `ASPERA_SCP_LICENSE`.
 
 ## 4.16.0
 
@@ -1053,7 +1056,7 @@ Released: 2021-02-03
 
 ### Breaking Changes
 
-* **global**: @stdin is now @stdin
+* **global**: `@stdin` is now `@stdin:`
 
 ## 0.9.10
 

data/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Reporting Issues and Vulnerabilities
 
-If you encounter a problem or vulnerability, please report it at [GitHub Issues](https://github.com/IBM/aspera-cli/issues).
+If you encounter a problem or a security vulnerability, please report it on [GitHub Issues](https://github.com/IBM/aspera-cli/issues).
 
 Before submitting a new issue:
 
@@ -16,8 +16,8 @@ To help us assist you efficiently, include the following in your report:
   ascli version
   ```
 
-- Confirmation that you're using the latest version (update if not).
-- The output of your Ruby environment:
+- Confirmation that you are using the latest version (update it if needed).
+- Your Ruby version information:
 
   ```bash
   ruby -v
@@ -29,7 +29,7 @@ We welcome contributions to improve the `aspera-cli` project!
 
 ### Getting Started
 
-Clone the repository and navigate to the project's main folder:
+Clone the repository and navigate to the project's root directory:
 
 ```bash
 git clone https://github.com/IBM/aspera-cli.git
@@ -50,7 +50,7 @@ To submit a contribution:
 
 1. **Implement** your feature or bug fix.
 
-1. **Write tests** to ensure your changes are robust and won’t break future versions.
+1. **Write tests** to ensure your changes are robust and prevent regressions.
 
 1. Run `rubocop` to ensure your code follows the Ruby style guide.
 
@@ -67,25 +67,25 @@ The overall architecture of `aspera-cli` is modular and extensible.
 
 ![Architecture](docs/architecture.png)
 
-Structure Highlights:
+### Structure Highlights
 
 - Entry Point:
 
-  `lib/aspera/cli/main.rb` - This is where the CLI execution begins.
+  `lib/aspera/cli/main.rb`, CLI startup logic.
 
 - Plugins:
 
-  Located in `lib/aspera/cli/plugins`, plugins extend CLI functionality and encapsulate specific features.
+  Located in `lib/aspera/cli/plugins`; plugins extend CLI functionality and encapsulate specific features.
 
 - Transfer Agents:
 
-  Found in `lib/aspera/agent`, these handle data transfers operations.
+  Found in `lib/aspera/agent`, these handle data transfer operations.
 
-A list of classes are provided in <docs/uml.png>
+Class diagrams are provided in <docs/uml.png>
 
-## Ruby version
+## Ruby Environment
 
-`aspera-cli` is built with Ruby.
+`aspera-cli` is written in Ruby.
 You can install Ruby using any method you prefer (e.g., `rbenv`, `rvm`, system package manager).
 
 To start with a clean state and remove all installed gems:
@@ -97,30 +97,28 @@ bundle exec rake tools:clean_gems
 > [!TIP]
 > This is especially useful before testing across different Ruby versions or preparing for a release.
 
-## Tool chain
+## Toolchain
 
-TODO: document installation of tool chain.
-
-Build system uses Ruby's `rake`.
+The build system uses Ruby's `rake`.
 
 ### Environment
 
-A few macros/env vars control some aspects:
+A few macros and environment variables control certain aspects of the build:
 
-| Environment variable        | Description                                        |
-|-----------------------------|----------------------------------------------------|
-| `ASPERA_CLI_TEST_CONF_FILE` | Path to configuration file with secrets for tests. |
-| `ASPERA_CLI_DOC_CHECK_LINKS`| Check links still exist during doc generation.     |
-| `LOG_LEVEL`                 | Change log level in `rake` tasks.                  |
-| `ENABLE_COVERAGE`           | Tests with coverage analysis if set.               |
-| `SIGNING_KEY`               | Path to signing key to build Gem.                  |
-| `GEM_VERSION`               | Override gem version for builds.                   |
+| Environment variable        | Description                                         |
+|-----------------------------|-----------------------------------------------------|
+| `ASPERA_CLI_TEST_CONF_FILE` | Path to configuration file with secrets for tests.  |
+| `ASPERA_CLI_DOC_CHECK_LINKS`| Check links still exist during doc generation.      |
+| `LOG_LEVEL`                 | Change log level in `rake` tasks.                   |
+| `ENABLE_COVERAGE`           | Enable test coverage analysis when set.             |
+| `SIGNING_KEY`               | Path to the signing key used to build the gem file. |
+| `GEM_VERSION`               | Override gem version for builds.                    |
 
-Those macros can be set either in an env var, or on the `rake` command line.
+These can be set either as environment variables or directly on the `rake` command line.
 
 > [!NOTE]
-> Env vars `ASPERA_CLI_*` are typically set in user's shell profile for development.
-> Others are more for "one shot" use (on command line).
+> Environment variables `ASPERA_CLI_*` are typically set in the user’s shell profile for development.
+> Others are intended for one‑time use on the command line.
 
 To use the CLI directly from the development environment, add this to your shell profile (adapt the real path):
 
@@ -134,9 +132,9 @@ export RUBYLIB=$dev_ascli/lib:$RUBYLIB
 
 Documentation is generated with `pandoc` and `LaTeX`.
 
-IBM font `Plex` is used, for installation see [IBM Plex](https://www.ibm.com/plex/).
+The IBM `Plex` font is used; for installation instructions, see [IBM Plex](https://www.ibm.com/plex/).
 
-On macOS to install `lualatex` and all packages:
+On macOS, to install `lualatex` and all packages:
 
 ```bash
 brew install texlive
@@ -149,9 +147,9 @@ tlmgr update --self
 tlmgr install fvextra selnolig lualatex-math
 ```
 
-To check URL during doc generation, set env var: `ASPERA_CLI_DOC_CHECK_LINKS=1`.
+To check URLs during documentation generation, set the environment variable: `ASPERA_CLI_DOC_CHECK_LINKS=1`.
 
-To debug doc generation, set env var: `ASPERA_CLI_DOC_DEBUG=debug`.
+To debug documentation generation, set the environment variable: `ASPERA_CLI_DOC_DEBUG=debug`.
 
 ## Test Environment
 
@@ -172,7 +170,7 @@ If you don't want to install optional gems:
 bundle config set without optional
 ```
 
-Build beta version:
+To build a beta version:
 
 ```bash
 export GEM_VERSION=$(env -u GEM_VERSION rake tools:version).$(date +%Y%m%d%H%M)
@@ -180,9 +178,9 @@ export GEM_VERSION=$(env -u GEM_VERSION rake tools:version).$(date +%Y%m%d%H%M)
 
 ### Signed gem
 
-A private key is required to generate a signed Gem.
-Its path must be set using envvar `SIGNING_KEY`.
-The gem is signed with the public certificate found in `certs` and the private key pointed by `SIGNING_KEY` (kept secret by maintainer).
+A private key is required to generate a signed gem.
+Its path must be set using environment variable `SIGNING_KEY`.
+The gem is signed with the public certificate found in `certs` and the private key specified by `SIGNING_KEY` (kept secret by the maintainer).
 
 ```bash
 bundle exec rake build SIGNING_KEY=/path/to/vault/gem-private_key.pem
@@ -198,7 +196,7 @@ Update with:
 bundle exec rake tools:grpc
 ```
 
-It downloads the latest proto file and then compiles it.
+It downloads the latest `proto` file and then compiles it.
 
 ## Container image build
 
@@ -214,16 +212,48 @@ To list operations:
 bundle exec rake -T ^binary:
 ```
 
-## Development check list for new release
+## Release
+
+### Checklist before a new release
+
+When preparing for a new release, do the following:
+
+- Run the test suite:
+
+```bash
+bundle exec rake test:run
+```
+
+- Set beta version (to use the gem file built):
+
+```bash
+export GEM_VERSION=$(env -u GEM_VERSION rake tools:version).$(date +%Y%m%d%H%M)
+```
+
+- Verify that the container builds successfully (using the beta version):
+
+```bash
+bundle exec rake container:build
+bundle exec rake container:test
+```
+
+### Version Release Process
+
+Once the development branch is ready for release:
+
+- Decide on the version number
+
+- Update the version in `lib/aspera/cli/version.rb`
 
-When preparing for a new release do the following:
+- Execute `bundle exec rake release` (see `.github/workflows/deploy.yml`)
 
-- TODO
+  - It builds the `.gem` file in the `pkg` folder.
+  - Then runs `gem push`.
 
-## Long Term Implementation and delivery improvements
+## Long‑Term Implementation and Delivery Improvements
 
-- replace Rest and OAuth classes with ruby standard gems:
+- Replace custom REST and OAuth classes with standard Ruby gems:
   - <https://github.com/rest-client/rest-client>
   - <https://github.com/oauth-xx/oauth2>
-- use gem Thor <http://whatisthor.com/> (or other standard Ruby CLI manager)
-- look at <https://github.com/phusion/traveling-ruby>
+- Use the `thor` gem <http://whatisthor.com/> (or other standard Ruby CLI manager)
+- Look at <https://github.com/phusion/traveling-ruby>