Repository navigation
docs(cli): --type elf still requires --uuid in 0.8.0 - #75
Merged
Merged
Conversation
The published @bugsee/cli 0.8.0 binary rejects --type elf without --uuid (exit 20). Directory and zip inputs are keyed by GNU build-id, but the flag remains required for the SDK BUILD_UUID. Match the examples and option table to that behaviour. Co-authored-by: Alexey Karimov <krassx@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The 0.8.0 CLI docs (PR #74) showed
--type elfdirectory /native-debug-symbols.zipexamples without--uuid. That does not match the published@bugsee/cli0.8.0 binary.This is a docs mismatch, not a CLI bug: 0.8.0 keys each library by GNU build-id, but
--uuid(the SDKBUILD_UUID) is still required and only correlates logs. Omitting it was not an intended 0.8.0 change.Evidence
Installed
@bugsee/cli@0.8.0from npm (bugsee-cli 0.8.0). Dry-ran against a real aarch64 ELF (libsymbol1.so, GNU build-idbca64abfec40dbb631bb8f1c37414472) as both a directory and anative-debug-symbols.zip.--uuid.soconfiguration error: --uuid is required when --type elf (the resolved BUILD_UUID from the SDK's asset channel).sodry-run: would register + upload 1 librariesnative-debug-symbols.zipnative-debug-symbols.zipdry-run: would register + upload 1 libraries--extension so.debug,dbg(docs example)--extension so.debug,dbgThe
--uuidcheck runs before path scanning: an empty directory without--uuidis also exit 20, not 10.Commands (representative):
Why this is intended 0.8.0 behaviour
bugsee-cli debug-files upload --help(0.8.0):--uuidis Required for--type elf.v0.8.0):--uuid(the SDK'sBUILD_UUID) is still required but only correlates logs.src/cli/debug_files.rs):config_invalid("--uuid is required when --type elf …");run_elf_uploadlogsbuild_uuidfor correlation only.uuid_override_is_required_for_elfintests/debug_files_flags.rsasserts exit 20.--uuidrequirement.Docs changes
docs/cli/debug-files.md: add--uuidto every--type elfexample (directory, zip,--extension); mark it required in the options table; state that it is required (exit 20) and that GNU build-id remains the per-library key.docs/cli/release-notes.md: 0.8.0 ELF note now says--uuidis still required.No other pages changed.
Checked
npx cspell "docs/**/*.md" "docs/**/*.mdx" --no-cache -c cspell.json: 0 issues (294 files).node scripts/sync-skills.mjs && npm run build && node scripts/copy-raw-markdown.mjs: succeeds.