soos-io / soos-ci-analysis-circleci-orb Goto Github PK

Hello SOOS team 👋

I am from the @circleci Community and Partner Engineering team, here to help with a review for the CircleCI orb partnership. I have a few action items below for you:

Changes:

• Remove unnecessary parameters from the executor provided:

Unless I am missing something, the only parameter you require in your executor is the tag. The rest are only used in your jobs/command.

• Fix tag parameter description:

Your parameter description mentions node. I believe this should be python based on the executor's name and docker image.

• Consider changing the on_failure parameter to enum or link to docs with the parameter's options:

It sounds like this parameter has multiple options, but I couldn't easily find the accepted arguments in the orb or your docs. It's a good idea to make it an enum and/or insert the docs URL in the parameter description (example) for more information.

• Change the mode parameter to enum.

You did an excellent job explaining the valid arguments, and I believe you could further enforce them by making this parameter an enum.

• Remove empty spaces between jobs parameters and requires.

Remove the lines: 206 and 270.

• Remove the mode parameter options and their explanations from the soos-analysis job description.

The options are listed and explained in the parameter description. There is no need to duplicate this information in the job description.

Optional:

• Consider writing your orb using CircleCI's Orb Development Kit. It will increase your orb's maintainability and make it easier to extend its functionality in the future, should it be needed.

Questions:

• I can see some parameters in the command that are not explicitly used in your orb. Some examples are SOOS_BUILD_URI and SOOS_OPERATING_ENVIRONMENT. Do they serve any purpose?

After addressing the issues above, please provide us with a successful run link. Should you have any questions, feel free to post them here, and I'll be happy to help!