Problem:

The orb-tools orb is used when publishing new orbs on CircleCI. One of the orb's jobs, review, is used to check if the orb scripts are following best practices. One common case is that the length of the command is too long:

RC009: Complex Run step's commands should be imported. 
9/10 in 1 sec ✗ RC009: Complex Run step's commands should be imported.

Solutions:

Solution 1 - Importing the run step command as a script
- The script can be saved in a separate file and then import it when compiling the orb code. This is done via the file include syntax.
  
  Here is an example of how to import a script from the scripts/file.sh:
```
description: A simple command that imports from a file when packed.
steps:
  - run:
      name: Hello Greeting
      command: <<include(scripts/file.sh)>>
```
Solution 2 - Overriding the number of characters allowed
- It is also possible to manually override the number of maximum characters allowed by the review command by passing in a value for the max_command_length parameter:
```
- orb-tools/review:
    max_command_length: 200
```
Solution 3 - Disable the check
- Specific checks can also be disabled by passing in the reference code (starting with RC) for the individual rule. The code for command character length is RC009:
```
- orb-tools/review:
    exclude: RC009
```

Outcome:

With the above solutions, you will no longer see the job failing the required checks.

Additional Resources:

If further resources/notes are necessary or prove relevant to the context, linking them at the end for follow-up can guide customers on any further steps they may need to take or be mindful of after their error is resolved or unresolved.

Troubleshooting orb-tools orb review job complex run step error

Problem:

Solutions:

Outcome:

Additional Resources:

Comments

Articles in this section