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

Allow orb-tools/review RC009 to have a customized character length #151

Closed hannahkamundson closed 1 year ago

hannahkamundson commented 2 years ago

Describe Request:

Right now orb-tools/review RC009 will fail a job if it is over 64 characters. Our organization would like to customize that number so we can make the character limit larger.

Examples:

Supporting Documentation Links:

https://circleci.com/developer/orbs/orb/circleci/orb-tools#jobs-review https://github.com/CircleCI-Public/orb-tools-orb/blob/6a148422095c99ba9c0995016d27b82fe89f862f/src/scripts/review.bats#L166

KyleTryon commented 1 year ago

Hey @hannahkamundson thanks for sharing this, it makes sense. Do you have any thoughts on how you would like to set this option?

The easiest solution is to add parameters to the job although i do worry we could end up with a lot of them.

- orb-tools/review:
    RC009_COMMAND_LENGTH: 123

A side question, are you looking to remove the limit or change it to something longer? What is your ideal length?

EricRibeiro commented 1 year ago

Hey @hannahkamundson thanks for sharing this, it makes sense. Do you have any thoughts on how you would like to set this option?

The easiest solution is to add parameters to the job although i do worry we could end up with a lot of them.

- orb-tools/review:
    RC009_COMMAND_LENGTH: 123

A side question, are you looking to remove the limit or change it to something longer? What is your ideal length?

An alternative to adding parameters is creating a configuration file for the Orb Tools. Something similar to tsconfig.json for TypeScript:

{
  "rc009": {
    "maxCommandLength": 123
  }
}

It's an easily extensible alternative.