Skip to content

Documentation regarding executable-path is misleading #40

Description

@idantene

Hey!

The README for this action suggests executable-path is a directory (GITHUB_WORKSPACE/bin/), but in reality, the code calls path.dirname() on the provided value (here), so the executable-path should actually be the path to the executable (as per the variable name).
The documentation is currently a bit misleading on that one.

This might be less obvious, and also would beg the question if the user can set the executable name this way?
Would it be better if this was actually the path, and the code would join the cloudsmith binary filename, as in:

const EXECUTABLE_PATH = path.join(core.getInput('executable-path') || path.join(process.env.GITHUB_WORKSPACE, 'bin'), 'cloudsmith');

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions