CircleCI-Public / orb-tools-orb

Various tools for authoring and publishing CircleCI orbs
https://circleci.com/orbs/registry/orb/circleci/orb-tools
MIT License
51 stars 74 forks source link

Feat(#162): Adding a version parameter. #165

Closed rodrigo-fagundes closed 1 year ago

rodrigo-fagundes commented 1 year ago

This is a draft for the suggestion in discussion in issue #162 . I'm not used to authoring orb, so please lmk if I can improve something.

The idea behind this PR is to decouple the version from GITHUB_TAG, allowing the intended tag to be passed as a parameter. As a result, anyone with a custom TAG definition or who organizes their orbs in a monorepo would be able to publish their orbs without any friction.

Although it would open the possibility for publishing to fail if the parameter diverges from the expected semver format, anyone who's programming their own pipeline to publish should be able to quickly detect and fix their issue by passing the parameter properly as per documentation.

In order to maintain backwards compatibility, GITHUB_TAG could still be used as the default parameter - if none is passed.

KyleTryon commented 1 year ago

closing as resolved