| Copyright | (c) 2025 Bellroy Pty Ltd |
|---|---|
| License | BSD-3-Clause |
| Maintainer | Bellroy Tech Team <haskell@bellroy.com> |
| Safe Haskell | None |
| Language | Haskell2010 |
Language.Github.Actions.Shell
Description
This module provides the Shell type for specifying which shell to use when
running commands in GitHub Actions steps.
Different shells provide different capabilities and are available on different operating systems. The shell can be specified at the workflow, job, or step level.
For more information about GitHub Actions shell configuration, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell
Documentation
Shell types available for running commands in GitHub Actions steps.
Each shell has different capabilities and platform availability:
Bash- Available on all platforms, most commonly usedSh- POSIX sh, available on Linux and macOS onlyPython- Executes commands as Python codeCmd- Windows Command Prompt, Windows onlyPowershell- Windows PowerShell 5.1, Windows onlyPwsh- PowerShell Core, available on all platforms
Example usage:
import Language.Github.Actions.Shell -- Use bash with default options bashShell :: Shell bashShell = Bash Nothing -- Use bash with specific options bashWithOptions :: Shell bashWithOptions = Bash (Just "--noprofile --norc") -- Use PowerShell Core pwshShell :: Shell pwshShell = Pwsh Nothing
For more details, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell
Constructors
| Bash (Maybe Text) | Bash shell with optional arguments |
| Sh (Maybe Text) | POSIX sh shell (Linux/macOS only) with optional arguments |
| Python (Maybe Text) | Python interpreter with optional arguments |
| Cmd (Maybe Text) | Windows cmd.exe with optional arguments |
| Powershell (Maybe Text) | Windows PowerShell 5.1 with optional arguments |
| Pwsh (Maybe Text) | PowerShell Core with optional arguments |