microsoft / microsoft/azure-linux-dev-tools

request: `azldev comp show-spec`: read-only spec viewing

Open
#32 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ai usabilty area: source management enhancement
Dominant language
Go
Stars
18
Forks
27
Avg merge
4d 33m
Merged PRs (30d)
24

Description

Pain point: To inspect an upstream spec before adding overlays, you currently need to:

  1. Add a bare [components.<name>] entry to components.toml
  2. Run azldev comp prep-sources -p <name> --skip-overlays -o /tmp/inspect
  3. Read the spec
  4. Remove the temp entry

A dedicated read-only command would eliminate steps 1 and 4.

Proposed: azldev comp show-spec -p <name> — fetches and displays the upstream spec without requiring the component to be registered. Could also support --upstream-distro and --upstream-version flags.

--
Imported on behalf of @dmcilvaney

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing azldev comp prep-sources -p <name> --skip-overlays command and trace its component registration and upstream-spec fetching entry points. Add a read-only azldev comp show-spec -p <name> path that works without a components.toml entry; verify the displayed spec and, if implemented, the --upstream-distro and --upstream-version flags.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.