Skip to content

Commit a82b6ec

Browse files
doc
Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>
1 parent 7a97d9e commit a82b6ec

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ A few macros and environment variables control certain aspects of the build:
116116

117117
These can be set either as environment variables or directly on the `rake` command line.
118118

119-
Setting `SIGNING_KEY_PEM` creates file `$HOME/.gem/signing_key.pem` and sets `SIGNING_KEY`.
119+
Setting `SIGNING_KEY_PEM` creates file `$HOME/.gem/signing_key.pem` and sets `SIGNING_KEY` to that path.
120120

121121
> [!NOTE]
122122
> Environment variables `ASPERA_CLI_*` are typically set in the user’s shell profile for development.
@@ -153,6 +153,12 @@ To check URLs during documentation generation, set the environment variable: `AS
153153

154154
To debug documentation generation, set the environment variable: `ASPERA_CLI_DOC_DEBUG=debug`.
155155

156+
To generate documentation:
157+
158+
```bash
159+
rake doc:build
160+
```
161+
156162
## Test Environment
157163

158164
Refer to <tests/README.md>.
@@ -192,7 +198,7 @@ Update with:
192198
bundle exec rake tools:grpc
193199
```
194200

195-
It downloads the latest `proto` file and then compiles it.
201+
It downloads the latest `proto` file and then compiles it into ruby sources included in the repo.
196202

197203
## Container image build
198204

@@ -212,7 +218,8 @@ bundle exec rake -T ^binary:
212218

213219
### Branching Strategy
214220

215-
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.
221+
This project uses a single `main` branch for development.
222+
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.
216223

217224
Feature development and bug fixes can be done either:
218225

@@ -252,16 +259,17 @@ To create a release:
252259
The workflow automatically:
253260

254261
1. Updates `version.rb` with the release version
255-
2. Rebuilds documentation (PDF manual, README)
262+
2. Rebuilds documentation (PDF manual, Markdown README)
256263
3. Commits the changes
257264
4. Creates and pushes the release tag
258265
5. Triggers the `deploy` workflow to publish to [rubygems.org](https://rubygems.org/gems/aspera-cli)
259266
6. Updates `version.rb` to the next development version with `.pre` suffix
260-
7. Commits and pushes the version bump
267+
7. Commits and pushes the version bump in main branch.
261268

262269
### Manual Release Process (Alternative)
263270

264-
If needed, releases can still be done manually:
271+
If needed, releases can still be done manually.
272+
Basically, follow the same procedure as in the GitHub action:
265273

266274
- Update the version in `lib/aspera/cli/version.rb` (remove `.pre` suffix)
267275

0 commit comments

Comments
 (0)