|
1 | | -# This file controls the release system. |
| 1 | +# This file controls the toys-release gem. |
2 | 2 |
|
3 | 3 | # The repo organization and name. |
4 | 4 | repo: open-telemetry/opentelemetry-ruby |
| 5 | + |
5 | 6 | # Time in seconds for release scripts to wait for CI to complete. |
6 | 7 | required_checks_timeout: 1200 |
| 8 | + |
7 | 9 | # Git user attached to commits for release pull requests. |
8 | 10 | git_user_name: otelbot |
9 | 11 | git_user_email: 197425009+otelbot@users.noreply.github.com |
10 | 12 |
|
11 | 13 | # List of all releaseable gems. Each gem should include: |
12 | 14 | # * name: The name of the gem. (Required.) |
13 | | -# * directory: Gem directory relative to the repo root. (Required.) |
| 15 | +# * directory: Gem directory relative to the repo root. |
| 16 | +# (Required unless the gem name matches the directory name exactly. This |
| 17 | +# means it's always required in this repo because all the gem names include |
| 18 | +# the word "opentelemetry" whereas the directory names do not.) |
14 | 19 | # * version_rb_path: Path to version.rb relative to the gem directory. |
15 | 20 | # (Required only if it does not match the gem name. e.g. The gem |
16 | | -# "opentelemetry-sdk" would default to lib/opentelemetry/sdk/version.rb) |
| 21 | +# "opentelemetry-sdk" would default to "lib/opentelemetry/sdk/version.rb", |
| 22 | +# so this field is required only if the actual path is different.) |
17 | 23 | # * version_constant: The fully-qualified version constant as an array. |
18 | | -# (Required because the OpenTelemetry namespace does not match the gem |
19 | | -# name "opentelemetry".) |
| 24 | +# (Required if the actual constant name, including its capitalization, |
| 25 | +# differs from what would be inferred from the gem name. This means it's |
| 26 | +# always required in this repo, because the capitalization of the |
| 27 | +# "OpenTelemetry" namespace does not match the gem name "opentelemetry".) |
20 | 28 | # * changelog_path: Path to CHANGLEOG.md relative to the gem directory. |
21 | | -# (Required only if it is not in the expected location.) |
| 29 | +# (Required only if it is not in the expected location, which is the file |
| 30 | +# "CHANGELOG.md" at the root of the gem directory.) |
22 | 31 | gems: |
23 | 32 | - name: opentelemetry-api |
24 | 33 | directory: api |
|
0 commit comments