-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Refactor spec/semconv integration workflows: extract pick-branch helper #9682
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
chalin
merged 2 commits into
open-telemetry:main
from
chalin:chalin-m24-fix-spec-upd-action-2026-0418
Apr 20, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import { describe, test } from 'node:test'; | ||
| import assert from 'node:assert/strict'; | ||
|
|
||
| import { parseCliArgs, cliUsage } from './index.mjs'; | ||
|
|
||
| describe('pick-branch: CLI args', () => { | ||
| test('defaults: spec=otel, dry-run on when not in Actions', () => { | ||
| const result = parseCliArgs([], {}); | ||
| assert.equal(result.spec, 'otel'); | ||
| assert.equal(result.dryRun, true); | ||
| assert.equal(result.help, false); | ||
| assert.match(result.dryRunReason, /GITHUB_ACTIONS/); | ||
| }); | ||
|
|
||
| test('default dry-run is OFF when GITHUB_ACTIONS=true', () => { | ||
| const result = parseCliArgs([], { GITHUB_ACTIONS: 'true' }); | ||
| assert.equal(result.dryRun, false); | ||
| assert.equal(result.dryRunReason, 'GITHUB_ACTIONS=true'); | ||
| }); | ||
|
|
||
| test('default dry-run is ON when GITHUB_ACTIONS is set to anything else', () => { | ||
| assert.equal(parseCliArgs([], { GITHUB_ACTIONS: 'false' }).dryRun, true); | ||
| assert.equal(parseCliArgs([], { GITHUB_ACTIONS: '' }).dryRun, true); | ||
| }); | ||
|
|
||
| test('--dry-run forces dry-run even under Actions', () => { | ||
| const result = parseCliArgs(['--dry-run'], { GITHUB_ACTIONS: 'true' }); | ||
| assert.equal(result.dryRun, true); | ||
| assert.equal(result.dryRunReason, '--dry-run flag'); | ||
| }); | ||
|
|
||
| test('--no-dry-run forces writes even outside Actions', () => { | ||
| const result = parseCliArgs(['--no-dry-run'], {}); | ||
| assert.equal(result.dryRun, false); | ||
| assert.equal(result.dryRunReason, '--no-dry-run flag'); | ||
| }); | ||
|
|
||
| test('later --dry-run / --no-dry-run wins', () => { | ||
| assert.equal(parseCliArgs(['--no-dry-run', '--dry-run'], {}).dryRun, true); | ||
| assert.equal(parseCliArgs(['--dry-run', '--no-dry-run'], {}).dryRun, false); | ||
| }); | ||
|
|
||
| test('--spec=<id> selects a known spec', () => { | ||
| assert.equal(parseCliArgs(['--spec=semconv'], {}).spec, 'semconv'); | ||
| }); | ||
|
|
||
| test('--spec <id> (separate token) selects a known spec', () => { | ||
| assert.equal(parseCliArgs(['--spec', 'semconv'], {}).spec, 'semconv'); | ||
| }); | ||
|
|
||
| test('-s <id> short form selects a known spec', () => { | ||
| assert.equal(parseCliArgs(['-s', 'semconv'], {}).spec, 'semconv'); | ||
| }); | ||
|
|
||
| test('--help sets help flag without throwing', () => { | ||
| const result = parseCliArgs(['--help'], {}); | ||
| assert.equal(result.help, true); | ||
| }); | ||
|
|
||
| test('-h short form sets help flag', () => { | ||
| assert.equal(parseCliArgs(['-h'], {}).help, true); | ||
| }); | ||
|
|
||
| test('unknown --spec value throws', () => { | ||
| assert.throws(() => parseCliArgs(['--spec=bogus'], {}), /Unknown --spec/); | ||
| }); | ||
|
|
||
| test('unknown flag throws', () => { | ||
| assert.throws(() => parseCliArgs(['--bogus'], {}), /Unknown argument/); | ||
| }); | ||
|
|
||
| test('--spec without value throws', () => { | ||
| assert.throws(() => parseCliArgs(['--spec'], {}), /Missing value/); | ||
| }); | ||
|
|
||
| test('cliUsage mentions both specs and the dry-run flags', () => { | ||
| const text = cliUsage(); | ||
| assert.match(text, /otel\|semconv/); | ||
| assert.match(text, /--dry-run/); | ||
| assert.match(text, /--no-dry-run/); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@carlosalberto and @open-telemetry/specs-approvers, this is a writeup of what to do before publishing a release. Is this clear & helpful? See the section for "Spec / semconv SIG maintainers". Feedback welcome. For a preview, see https://deploy-preview-9682--opentelemetry.netlify.app/docs/contributing/sig-practices/#spec-integration-branches
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Merging now, but feedback is still welcome.