Skip to content

New version isn't available as an output #12

Closed
@jcrqr

Description

@jcrqr

Currently the newly created version is only available in the (undocumented) REVISION env variable.

Having the version as an environment variable is useful in simple cases but if you're using commitizen-action multiple times (i.e. different workspaces) or have any other step that sets that env var, it gets overwritten.

It can be more useful if the new version is available as an output of the step (i.e.: version), so it could be used like this:

- id: cz
  uses: commitizen-tools/commitizen-action@master
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
     
- run: |
    echo "The new version is ${{ steps.cz.outputs.version }}"

Additionally, I don't think the REVISION env variable should be removed for backwards compatibility, but should be documented in the README, so it's easier for new people to know about it without having to look at the source code.

Any thoughts?

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