Skip to content

[FR] Make another action CodSpeedHQ/setup-codspeed #146

@webknjaz

Description

@webknjaz

I have a use-case where I'd like to have the codspeed executable made available (perhaps also pre-authenticated) but then I'd need to call it myself in a way that this action can't (in my own wrappers). I've filed CodSpeedHQ/runner#135 and it'd help me solve this on one level but I believe that this action would also need bit of refurb in the context of GHA traditions.

GitHub has official recommendation for making actions that expose CLI tools in workflow jobs that suggest using the setup-$TOOL pattern or naming. All their official actions follow this principle (actions/setup-python, actions/setup-node etc.), and also third parties aren't that far behind (astral-sh/setup-uv).

See: https://docs.github.com/en/actions/how-tos/create-and-publish-actions/create-a-cli-action.

This is basically what I'd like the action to do:

  1. Self-bootstrapping (making codspeed available on $PATH)
  2. Optional caching if applicable.
  3. Optional call to codspeed auth for saving the token in a config on disk.
  4. Never invoking codspeed run
  5. During teardown, remove the token from disk (runs.post requires the action to be JS-based, though: https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#runspost)

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