CircleCI-Archived / Orb-Project-Template

A starter template for orb projects. Build, test, and publish orbs automatically on CircleCI. Use the Orb Development Kit to get started.

Home Page:https://circleci.com/docs/2.0/orb-author/#orb-development-kit

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Enhancement: Provide shell example in README.md

Jaryt opened this issue · comments

Provide a comment on shell usage for different languages in scripts/README.md: https://github.com/CircleCI-Public/Orb-Project-Template/tree/master/src/scripts

ex:

steps:
  - run:
      environment:
        PARAM_TO: <<parameters.to>
      name: Hello <<parameters.to>
      shell: /bin/sh  # Not required for shell scripts, but useful for other shell environments i.e. python
      command: <<include(scripts/greet.sh)>>

This would help users who may expect the included script to execute without declaring the shell parameter: #25