|
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 | | -# The main branch name. Releases must happen on this branch. |
6 | | -main_branch: main |
7 | | -# Time in seconds for release scripts to wait for CI to complete. |
8 | | -required_checks_timeout: 1200 |
| 5 | + |
| 6 | +# Disable pre-release GitHub check requirements. |
| 7 | +required_checks: false |
| 8 | + |
| 9 | +# If commits are added when release pull requests are open, update those pull |
| 10 | +# requests to reflect the new commits. |
| 11 | +update_existing_requests: true |
| 12 | + |
9 | 13 | # Git user attached to commits for release pull requests. |
10 | 14 | git_user_name: otelbot |
11 | 15 | git_user_email: 197425009+otelbot@users.noreply.github.com |
12 | | -# Toys tool that builds YARD reference docs |
13 | | -docs_builder_tool: [yardoc] |
14 | | - |
15 | | -# Control the conventional commit linter. |
16 | | -commit_lint: |
17 | | - # Whether conventional commit errors should cause a GitHub check fail. |
18 | | - fail_checks: true |
19 | | - # Merge types allowed by the repo. |
20 | | - merge: squash |
21 | 16 |
|
22 | 17 | # List of all releasable gems. Each gem should include: |
23 | 18 | # * name: The name of the gem. (Required.) |
24 | | -# * directory: Gem directory relative to the repo root. (Required.) |
| 19 | +# * directory: Gem directory relative to the repo root. |
| 20 | +# (Required unless the gem name matches the directory name exactly. This |
| 21 | +# means it's always required in this repo because all the gem names include |
| 22 | +# the word "opentelemetry" whereas the directory names do not.) |
25 | 23 | # * version_rb_path: Path to version.rb relative to the gem directory. |
26 | 24 | # (Required only if it does not match the gem name. e.g. The gem |
27 | | -# "opentelemetry-sdk" would default to lib/opentelemetry/sdk/version.rb) |
28 | | -# * version_constant: The fully-qualified version constant as an array. |
29 | | -# (Required because the OpenTelemetry namespace does not match the gem |
30 | | -# name "opentelemetry".) |
| 25 | +# "opentelemetry-sdk" would default to "lib/opentelemetry/sdk/version.rb", |
| 26 | +# so this field is required only if the actual path is different.) |
31 | 27 | # * changelog_path: Path to CHANGELOG.md relative to the gem directory. |
32 | | -# (Required only if it is not in the expected location.) |
| 28 | +# (Required only if it is not in the expected location, which is the file |
| 29 | +# "CHANGELOG.md" at the root of the gem directory.) |
33 | 30 | gems: |
34 | 31 | - name: opentelemetry-api |
35 | 32 | directory: api |
36 | 33 | version_rb_path: lib/opentelemetry/version.rb |
37 | | - version_constant: [OpenTelemetry, VERSION] |
38 | 34 |
|
39 | 35 | - name: opentelemetry-registry |
40 | 36 | directory: registry |
41 | 37 | version_rb_path: lib/opentelemetry/instrumentation/registry/version.rb |
42 | | - version_constant: [OpenTelemetry, Instrumentation, Registry, VERSION] |
43 | 38 |
|
44 | 39 | - name: opentelemetry-sdk |
45 | 40 | directory: sdk |
46 | | - version_constant: [OpenTelemetry, SDK, VERSION] |
47 | 41 |
|
48 | 42 | - name: opentelemetry-sdk-experimental |
49 | 43 | directory: sdk_experimental |
50 | | - version_rb_path: lib/opentelemetry/sdk/experimental/version.rb |
51 | | - version_constant: [OpenTelemetry, SDK, Experimental, VERSION] |
52 | 44 |
|
53 | 45 | - name: opentelemetry-common |
54 | 46 | directory: common |
55 | | - version_rb_path: lib/opentelemetry/common/version.rb |
56 | | - version_constant: [OpenTelemetry, Common, VERSION] |
57 | 47 |
|
58 | 48 | - name: opentelemetry-exporter-otlp |
59 | | - # we append a slash here to avoid the naive substring start_with? directory-matching condition in underlying toys gem |
60 | | - # which causes exporter/otlp to incorrectly match when changes occur in exporter/otlp-logs or exporter/otlp-metrics |
61 | | - # https://github.com/dazuma/toys/blob/17ed449da8299f272b834470ff6b279a59e8070b/.toys/release/.lib/release_utils.rb#L436 |
62 | | - # https://github.com/open-telemetry/opentelemetry-ruby/issues/1792 |
63 | | - directory: exporter/otlp/ |
64 | | - version_constant: [OpenTelemetry, Exporter, OTLP, VERSION] |
| 49 | + directory: exporter/otlp |
65 | 50 |
|
66 | 51 | - name: opentelemetry-exporter-otlp-logs |
67 | 52 | directory: exporter/otlp-logs |
68 | | - version_constant: [OpenTelemetry, Exporter, OTLP, Logs, VERSION] |
69 | 53 |
|
70 | 54 | - name: opentelemetry-exporter-otlp-metrics |
71 | 55 | directory: exporter/otlp-metrics |
72 | | - version_constant: [OpenTelemetry, Exporter, OTLP, Metrics, VERSION] |
73 | 56 |
|
74 | 57 | - name: opentelemetry-exporter-zipkin |
75 | 58 | directory: exporter/zipkin |
76 | | - version_constant: [OpenTelemetry, Exporter, Zipkin, VERSION] |
77 | 59 |
|
78 | 60 | - name: opentelemetry-propagator-b3 |
79 | 61 | directory: propagator/b3 |
80 | | - version_constant: [OpenTelemetry, Propagator, B3, VERSION] |
81 | 62 |
|
82 | 63 | - name: opentelemetry-propagator-jaeger |
83 | 64 | directory: propagator/jaeger |
84 | | - version_constant: [OpenTelemetry, Propagator, Jaeger, VERSION] |
85 | 65 |
|
86 | 66 | - name: opentelemetry-semantic_conventions |
87 | 67 | directory: semantic_conventions |
88 | | - version_rb_path: lib/opentelemetry/semantic_conventions/version.rb |
89 | | - version_constant: [OpenTelemetry, SemanticConventions, VERSION] |
90 | 68 |
|
91 | 69 | - name: opentelemetry-test-helpers |
92 | 70 | directory: test_helpers |
93 | 71 | version_rb_path: lib/opentelemetry/test_helpers/version.rb |
94 | | - version_constant: [OpenTelemetry, TestHelpers, VERSION] |
95 | 72 |
|
96 | 73 | - name: opentelemetry-metrics-api |
97 | 74 | directory: metrics_api |
98 | 75 | version_rb_path: lib/opentelemetry/metrics/version.rb |
99 | | - version_constant: [OpenTelemetry, Metrics, VERSION] |
100 | 76 |
|
101 | 77 | - name: opentelemetry-metrics-sdk |
102 | 78 | directory: metrics_sdk |
103 | 79 | version_rb_path: lib/opentelemetry/sdk/metrics/version.rb |
104 | | - version_constant: [OpenTelemetry, SDK, Metrics, VERSION] |
105 | 80 |
|
106 | 81 | - name: opentelemetry-logs-api |
107 | 82 | directory: logs_api |
108 | 83 | version_rb_path: lib/opentelemetry/logs/version.rb |
109 | | - version_constant: [OpenTelemetry, Logs, VERSION] |
110 | 84 |
|
111 | 85 | - name: opentelemetry-logs-sdk |
112 | 86 | directory: logs_sdk |
113 | 87 | version_rb_path: lib/opentelemetry/sdk/logs/version.rb |
114 | | - version_constant: [OpenTelemetry, SDK, Logs, VERSION] |
0 commit comments