Skip to content

listen --help states the default CLI destination is "{source}-cli"; it is "cli-{source}" #423

Description

@leggetter

hookdeck listen --help says:

By default the Hookdeck Destination will be named "{source}-cli", and the
Destination CLI path will be "/". To set the CLI path, use the "--path" flag.

The code names it cli-<source>. pkg/listen/connection.go:90 is the only place a CLI destination gets created (git grep 'Type: "CLI"' -- pkg/ returns one non-test hit):

connectionDetails.DestinationName = fmt.Sprintf("%s-%s", "cli", sources[0].Name)

Same on v2.6.0, main and release/v3.0.0. The help text has read {source}-cli since 29e2801 (2024-08-05).

Observed: hookdeck listen 3000 cronofy prints

There's no CLI destination connected to cronofy, creating one named cli-cronofy

and the connection header renders (cli-cronofy).

This goes further than --help. The CLI reference on hookdeck.com is generated from these long descriptions (hookdeck/website scripts/generate-cli-docs.ts, driven by the CLI Docs Freshness workflow), so the wrong string gets published to the docs site. It was corrected by hand in the website repo in 357f09ab, but that correction sits inside a GENERATE block, so every regeneration reverts it - which is what https://github.com/hookdeck/website/pull/716 currently does.

Fix is the long description at pkg/cmd/listen.go:187.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions