aspera-cli 4.25.0.pre2 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e017349a111f8385f64794641aed296960fd8cd69bcfcf62110b99c102425c6
-  data.tar.gz: 15fb922208d24921bfbdd352d26b6085addf93231044318e942c7f0df67e4eea
+  metadata.gz: 9e812ee0dbd658feeaea8c37d4095df243f57a656b669e99460ca791585121a6
+  data.tar.gz: a52360171fc63925f01cd7562453484d04e795221c02c36b78e29c99ed25276e
 SHA512:
-  metadata.gz: a6ed834dce6f0991bf9c1a2c2c16b9c8d8224961b4c6cf453a3873d1fba1378bf3a1e825351f7b4dc349ac1e9cc325a0b47c2bd25dc9e6c23ecc8cd140ba0e09
-  data.tar.gz: cd07513558920ae564bbae2da2441d1173a05700ed2dbaa9a6edbd8b17fffe0eec79b48dbe76b63438d97f870bc1113b247f65c861000f0f967dcca1a290a37c
+  metadata.gz: 70cb5577853b1c8c0a86e85dc55e0e43d9f0c2d18a58f9bf560375c67a76a04e1c06395321789ba8edbcec05c68e7642df2fb9ed5133a8c333992c8254e42dee
+  data.tar.gz: 0d25857a31812782d7f831b5f9b4e95962621d4a712dbcbfa9be3889359dc163ca5914a57d7fe5b543b7010d7051865400adc47c590e33ae6f56b7131183e0a6

data/CHANGELOG.md

@@ -14,6 +14,7 @@ Released: [Place date of release here]
 * **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`.
+* `aoc`: The admin command for `node` now support nodes owned by admin, so that secret is no more necessary.
 
 ### Issues Fixed
 
@@ -23,8 +24,10 @@ Released: [Place date of release here]
 ### Breaking Changes
 
 * `aoc`: Option `package_folder` is now a Hash instead of formatted String.
+* `aoc`: Deprecated option `scope`. It is selected from the command directly. For `bearer_token --scope=admin:all`, now use: `admin bearer_token`.
 * `server`: By default, SSH option `use_agent` is now `false`.
 * `config`: Removed option `use_product`, replaced with prefix `product:` of option `ascp_path`.
+* `config`: Secret lookup is no more automatic, activate setting option `secret` to `PRESET`.
 * `faspex5`: Removed deprecated (4.18) command in `admin`: `resource`, use resource name as command directly in `admin`.
 * `preview`: Replaced gem `mimemagic` with `marcel`.
 * **global**: Extended value modifier `@stdbin:` is replaced with `@stdin:bin`.

data/CONTRIBUTING.md

@@ -107,7 +107,7 @@ 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_TEST_CONF_URL`  | URL for 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.             |
@@ -118,7 +118,7 @@ These can be set either as environment variables or directly on the `rake` comma
 
 > [!NOTE]
 > 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.
+> Others are intended for use on the command line.
 
 To use the CLI directly from the development environment, add this to your shell profile (adapt the real path):
 
@@ -157,11 +157,11 @@ Refer to <tests/README.md>.
 
 ## Build
 
-The gem is built with:
+The unsigned gem is built with:
 
 ```bash
 bundle install
-bundle exec rake build
+bundle exec rake unsigned
 ```
 
 If you don't want to install optional gems:
@@ -183,7 +183,7 @@ 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
+bundle exec rake SIGNING_KEY=/path/to/vault/gem-private_key.pem
 ```
 
 Refer to <certs/README.md>.
@@ -214,7 +214,16 @@ bundle exec rake -T ^binary:
 
 ## Release
 
-### Checklist before a new release
+### Branching Strategy
+
+This project uses a single `main` branch for development. During the development cycle, the version in `lib/aspera/cli/version.rb` uses a `.pre` suffix (e.g., `x.y.z.pre`) to indicate a pre-release state.
+
+Feature development and bug fixes can be done either:
+
+- Directly on `main` for small changes
+- Via feature branches with pull requests for larger changes
+
+### Checklist Before a New Release
 
 When preparing for a new release, do the following:
 
@@ -224,31 +233,64 @@ When preparing for a new release, do the following:
 bundle exec rake test:run
 ```
 
-- Set beta version (to use the gem file built):
+- Verify that the container builds successfully (using the beta version):
 
 ```bash
 export GEM_VERSION=$(env -u GEM_VERSION rake tools:version).$(date +%Y%m%d%H%M)
+bundle exec rake container:build
+bundle exec rake container:test
 ```
 
-- Verify that the container builds successfully (using the beta version):
+### Automated Release Process
 
-```bash
-bundle exec rake container:build
-bundle exec rake container:test
+Releases are triggered via the GitHub Actions UI using the **Release** workflow (`.github/workflows/release.yml`).
+
+To create a release:
+
+1. Navigate to **Actions** > **Release** in the GitHub repository
+2. Click **Run workflow**
+3. Optionally specify:
+   - **Release version**: The version to release. If left empty, uses the current version from `version.rb` without the `.pre` suffix.
+   - **Next development version**: The next version to prepare for. If left empty, auto-increments the minor version. The `.pre` suffix is added automatically.
+4. Click **Run workflow**
+
+The workflow automatically:
+
+1. Updates `version.rb` with the release version
+2. Rebuilds documentation (PDF manual, README)
+3. Commits the changes
+4. Creates and pushes the release tag
+5. Triggers the deploy workflow to publish to [rubygems.org](https://rubygems.org/gems/aspera-cli)
+6. Updates `version.rb` to the next development version with `.pre` suffix
+7. Commits and pushes the version bump
+
+### Manual Release Process (Alternative)
+
+If needed, releases can still be done manually:
+
+- Update the version in `lib/aspera/cli/version.rb` (remove `.pre` suffix)
+
+- Build the PDF manual in `pkg`:
+
+```shell
+bundle exec rake doc:build
 ```
 
-### Version Release Process
+- Build the signed `.gem` in `pkg`:
 
-Once the development branch is ready for release:
+```shell
+bundle exec rake SIGNING_KEY=/path/to/vault/gem-private_key.pem
+```
 
-- Decide on the version number
+- Create the release version tag and push it to GitHub:
 
-- Update the version in `lib/aspera/cli/version.rb`
+```shell
+bundle exec rake release_tag
+```
 
-- Execute `bundle exec rake release` (see `.github/workflows/deploy.yml`)
+This will trigger the action `.github/workflows/deploy.yml`, which builds the gem file and pushes it to RubyGems.
 
-  - It builds the `.gem` file in the `pkg` folder.
-  - Then runs `gem push`.
+- After release, update `version.rb` to the next development version with `.pre` suffix
 
 ## Long‑Term Implementation and Delivery Improvements