Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Treatment githubCommand

cicd/services/github::githubCommand


Inputs

⇥ run: Block<string>
⇥ shell: Block<Option<string>>

Outputs

↦ command: Stream<Command> (process/command::Command)


Build a shell Command for a GitHub Actions run step.

Given the optional shell name and the script content in run, writes the script to a temporary file and emits a Command value ready to be passed to an executor.

Supported shell values: "bash", "sh", "pwsh", "powershell", "python", "cmd". When shell is None, the platform default is used (bash on Unix, pwsh on Windows). Nothing is emitted if the shell name is unrecognised or if the script file cannot be written.

graph LR
     T("githubCommand()")
     S["〈🟦〉"] -->|shell| T
     R["〈🟨〉"] -->|run| T
     T -->|command| C["🟩 …"]
     style S fill:#ffff,stroke:#ffff
     style R fill:#ffff,stroke:#ffff
     style C fill:#ffff,stroke:#ffff