dtolnay / dtolnay/rust-toolchain
README doesn't mention this action requires bash on PATH (Windows)
- Dominant language
- Shell
- Stars
- 1.6k
- Forks
- 95
- Avg merge
- 2h 39m
- Merged PRs (30d)
- 1
Description
action.yml hardcodes \`shell: bash\` for every step. This works transparently on GitHub-hosted \`windows-latest\`, which ships Git Bash on PATH by default, but the README doesn't mention this dependency anywhere.
On a self-hosted Windows runner without Git Bash on PATH (e.g. a bare Windows Server AMI with only Git for Windows installed via its \`cmd\` directory, not \`bin\`), the action fails immediately with a bare:
\`\`\`
##[error]bash: command not found
\`\`\`
with no indication of why, since nothing in the README or action output mentions bash is required at all. Took a while to trace back to this, since the assumption is invisible on \`windows-latest\` and only surfaces on custom Windows runners.
Would be a quick, useful addition to the README: mention that self-hosted Windows runners need \`bash\` (e.g. Git Bash) available on PATH for this action to work.
Contributor guide
No contributing guide indexed for this repository
Research direction
Read README.md alongside action.yml to confirm the action's shell requirement and where runtime prerequisites are documented. Update the README to state that self-hosted Windows runners need bash, such as Git Bash, available on PATH; done when this dependency and the relevant failure context are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100