aspera-cli 4.25.1 → 4.25.3

data/CONTRIBUTING.md

@@ -110,12 +110,15 @@ A few macros and environment variables control certain aspects of the build:
 | `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.                   |
+| `LOG_SECRETS`               | Change log secrets 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.                    |
+| `SIGNING_KEY_PEM`           | PEM of signing key.                                 |
 
 These can be set either as environment variables or directly on the `rake` command line.
 
+Setting `SIGNING_KEY_PEM` creates file `$HOME/.gem/signing_key.pem` and sets `SIGNING_KEY` to that path.
+
 > [!NOTE]
 > Environment variables `ASPERA_CLI_*` are typically set in the user’s shell profile for development.
 > Others are intended for use on the command line.
@@ -151,6 +154,12 @@ To check URLs during documentation generation, set the environment variable: `AS
 
 To debug documentation generation, set the environment variable: `ASPERA_CLI_DOC_DEBUG=debug`.
 
+To generate documentation:
+
+```bash
+rake doc:build
+```
+
 ## Test Environment
 
 Refer to <tests/README.md>.
@@ -170,12 +179,6 @@ If you don't want to install optional gems:
 bundle config set without optional
 ```
 
-To build a beta version:
-
-```bash
-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.
@@ -196,7 +199,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 into ruby sources included in the repo.
 
 ## Container image build
 
@@ -216,7 +219,8 @@ bundle exec rake -T ^binary:
 
 ### 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.
+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:
 
@@ -233,11 +237,10 @@ When preparing for a new release, do the following:
 bundle exec rake test:run
 ```
 
-- Verify that the container builds successfully (using the beta version):
+- Verify that the container builds successfully (using the local gem file):
 
 ```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:build'[local]'
 bundle exec rake container:test
 ```
 
@@ -257,16 +260,17 @@ To create a release:
 The workflow automatically:
 
 1. Updates `version.rb` with the release version
-2. Rebuilds documentation (PDF manual, README)
+2. Rebuilds documentation (PDF manual, Markdown 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)
+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
+7. Commits and pushes the version bump in main branch.
 
 ### Manual Release Process (Alternative)
 
-If needed, releases can still be done manually:
+If needed, releases can still be done manually.
+Basically, follow the same procedure as in the GitHub action:
 
 - Update the version in `lib/aspera/cli/version.rb` (remove `.pre` suffix)
 
@@ -292,9 +296,9 @@ This will trigger the action `.github/workflows/deploy.yml`, which builds the ge
 
 - After release, update `version.rb` to the next development version with `.pre` suffix
 
-## Long‑Term Implementation and Delivery Improvements
+## Future Improvements
 
-- Replace custom REST and OAuth classes with standard Ruby 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 the `thor` gem <http://whatisthor.com/> (or other standard Ruby CLI manager)