Skip to content

[BUG] --host option documented for marketplace add does not exist in CLI #641

@kkadete

Description

@kkadete

Describe the bug
The documentation at https://microsoft.github.io/apm/guides/marketplaces/#register-a-marketplace shows the following example command:

apm marketplace add acme/plugin-marketplace --host ghes.corp.example.com

However, running this command results in an error stating --host is not a valid option.

To Reproduce
Steps to reproduce the behavior:

Run command apm marketplace add
With parameters acme/plugin-marketplace --host ghes.corp.example.com
See error

$ mx apm marketplace add acme/plugin-marketplace --host ghes.corp.example.com
Usage: apm.exe marketplace add [OPTIONS] REPO
Try 'apm.exe marketplace add --help' for help.

Error: No such option: --host

Expected behavior
The --host option should be accepted by apm marketplace add to allow specifying a GitHub Enterprise Server (GHES) host, as documented in the official guide.

Environment (please complete the following information):

OS: Windows
Python Version: 3.9.16
APM Version: 0.8.11
VSCode Version (if relevant): N/A

Logs

$ mx apm marketplace add acme/plugin-marketplace --host ghes.corp.example.com
Usage: apm.exe marketplace add [OPTIONS] REPO
Try 'apm.exe marketplace add --help' for help.

Error: No such option: --host

Additional context
Either the --host option is missing from the CLI implementation and needs to be added, or the documentation example needs to be corrected to reflect the actual supported options. Output of apm marketplace add --help:

apm marketplace add --help
Usage: apm.exe marketplace add [OPTIONS] REPO

  Register a plugin marketplace

Options:
  -n, --name TEXT    Display name (defaults to repo name)
  -b, --branch TEXT  Branch to use  [default: main]
  -v, --verbose      Show detailed output
  --help             Show this message and exit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugDeprecated: use type/bug. Kept for issue history; will be removed in milestone 0.10.0.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions