Skip to content
This repository has been archived by the owner on Jun 1, 2022. It is now read-only.

Enhancement: Provide shell example in README.md #35

Open
Jaryt opened this issue Feb 15, 2022 · 0 comments
Open

Enhancement: Provide shell example in README.md #35

Jaryt opened this issue Feb 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Jaryt
Copy link

Jaryt commented Feb 15, 2022

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

@Jaryt Jaryt added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant