Open Gaardsholt opened 2 years ago
I am interested. Highly considering this.
A few questions / considerations.
${{ORB_VERSION}}
(we would like use a syntax similar to << orb.prod.version >>) in an orb that was not your own in the situation where more than one orb is used.x.y.z
structure as we often do, there is no reason not to.circleci config validate
against the example.I think this is feasible. The publish job would use the CircleCI tag when publishing the orb to make an on-the-fly replacement of the template text. I think an expectation would need to be set that this is simply using the tag version in the pipeline and would only be valid on the orb being built, and should not be used on another orb.
GOOD
usage:
version: 2.1
orbs:
my-orb: my-namespace/my-orb@<< orb.prod.version >>
BAD
usage:
version: 2.1
orbs:
my-orb: my-namespace/my-orb@<< orb.prod.version >>
jq: circleci/jq@<< orb.prod.version >>
It should be possible to warn the user if we know the orb name and namespace, and ensure it is only used on matching lines.
Sorry for not replying, I totally forgot about this issue !
My comments on your points:
${{ORB_VERSION}}
or @<< orb.prod.version >>
.Is this something that is being worked on?
Describe Request:
It would be great if we could use a template value/variable to always have the examples show the correct version of the orb.
Examples:
Instead of writing the examples like this:
We could do something like this:
Supporting Documentation Links: