Skip to content

Commit 4e0b227

Browse files
committed
📝 Document no-document option
1 parent 3f69e1c commit 4e0b227

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ When `ruby-version` is set to `default` (the default), setup-ruby-flash reads fr
145145
| `skip-extensions` | Skip building native extensions | `false` |
146146
| `without-groups` | Gem groups to exclude (comma-separated) | `''` |
147147
| `ruby-install-retries` | Number of retry attempts for Ruby installation (with exponential backoff) | `3` |
148+
| `no-document` | Skip generating documentation (ri/rdoc) for installed gems. Creates `~/.gemrc` with `gem: --no-document` if file doesn't exist | `true` |
148149
| `token` | GitHub token for API calls | `${{ github.token }}` |
149150

150151
## Outputs
@@ -257,6 +258,18 @@ If you experience intermittent failures due to GitHub API rate limiting, you can
257258
ruby-install-retries: "5"
258259
```
259260

261+
### Enable Documentation Generation
262+
263+
Include documentation (ri/rdoc) for installed gems (default skips documentation for faster installation):
264+
265+
```yaml
266+
- uses: appraisal-rb/setup-ruby-flash@v1
267+
with:
268+
ruby-version: "3.4"
269+
ore-install: true
270+
no-document: false
271+
```
272+
260273
### Building rv or ore from Source
261274

262275
You can build rv or ore from a git branch, tag, or commit SHA instead of using a released version.

0 commit comments

Comments
 (0)