Skip to content

README documents output as bump, but action exposes bumpLevel #47

@ricogu-claw

Description

@ricogu-claw

Summary

The README and the action metadata are out of sync on the output name for the computed semantic version bump.

Evidence

README currently documents:

  • bump: The computed SemVer bump level (major, minor, or patch)

But the action metadata exposes:

  • bumpLevel

And the core action also sets bumpLevel in code.

Why this matters

This is user-facing documentation drift. Workflow authors following the README may try to consume steps.<id>.outputs.bump and get an empty value.

Expected behavior

The README, examples, and action metadata should consistently use the same output name.

Suggested resolution

  • Either update the README/examples to use bumpLevel
  • Or add a backward-compatible alias output if bump is considered the better public API
  • Add a small docs/test pass to ensure output names stay aligned

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