fix: drop shebang from bash completion template by barry3406 · Pull Request #2317 · urfave/cli

barry3406 · 2026-04-17T03:08:25Z

What type of PR is this?

bug

What this PR does / why we need it:

Bash completion scripts are sourced (not executed), so they shouldn't start with a #!/bin/bash shebang. Debian's lintian flags the generated completion with bash-completion-with-hashbang when downstream packagers ship it.

autocomplete/bash_autocomplete: drops the shebang line (and the blank line that followed it) so the embedded template starts with the existing # This is a shell completion script ... header comment.
completion_test.go: adds TestCompletionBashNoShebang, which renders the bash completion via shellCompletions["bash"] and asserts the output does not start with #!.

Which issue(s) this PR fixes:

Fixes #2259

Testing

go test ./... and go vet ./... pass locally. The new test fails without the template change and passes with it.

Release Notes

fix: drop shebang from bash completion template so it no longer trips `bash-completion-with-hashbang` when sourced

Bash completion scripts are sourced, not executed, so they should not begin with a `#!/bin/bash` shebang. Debian's lintian flags this as `bash-completion-with-hashbang`. Add a regression test that renders the bash completion and asserts the output does not start with `#!`. Fixes urfave#2259

This PR contains the following updates: | Package | Type | Update | Change | OpenSSF | |---|---|---|---|---| | [github.com/urfave/cli/v3](https://github.com/urfave/cli) | require | minor | `v3.8.0` → `v3.9.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/urfave/cli/badge)](https://securityscorecards.dev/viewer/?uri=github.com/urfave/cli) | --- > ⚠️ **Warning** > > Some dependencies could not be looked up. Check the [Dependency Dashboard](issues/23) for more information. --- ### Release Notes <details> <summary>urfave/cli (github.com/urfave/cli/v3)</summary> ### [`v3.9.0`](https://github.com/urfave/cli/releases/tag/v3.9.0) [Compare Source](urfave/cli@v3.8.0...v3.9.0) #### What's Changed - chore(deps): bump codecov/codecov-action from 5 to 6 by [@dependabot](https://github.com/dependabot)\[bot] in [#2300](urfave/cli#2300) - chore(deps): bump the python-packages group across 1 directory with 3 updates by [@dependabot](https://github.com/dependabot)\[bot] in [#2301](urfave/cli#2301) - docs: fix typo by [@acrobatstick](https://github.com/acrobatstick) in [#2299](urfave/cli#2299) - feat: add descriptions for bash and powershell autocompletion by [@gabelluardo](https://github.com/gabelluardo) in [#2298](urfave/cli#2298) - Made command help more consistent by [@markshep-wbg](https://github.com/markshep-wbg) in [#2287](urfave/cli#2287) - Fix:(issue\_2285): correct function and variable naming in fish completion script by [@TimSoethout](https://github.com/TimSoethout) in [#2286](urfave/cli#2286) - fix(ci): update docs after bash completion update by [@gabelluardo](https://github.com/gabelluardo) in [#2307](urfave/cli#2307) - fix: apply SliceFlagSeparator to env var sources by [@lawrence3699](https://github.com/lawrence3699) in [#2309](urfave/cli#2309) - fix: don't print empty line to stderr when Exit message is empty by [@Yanhu007](https://github.com/Yanhu007) in [#2310](urfave/cli#2310) - flag: prevent BoolWithInverseFlag.String from panicking without a tab by [@alliasgher](https://github.com/alliasgher) in [#2311](urfave/cli#2311) - refactor: bash completion script by [@gabelluardo](https://github.com/gabelluardo) in [#2308](urfave/cli#2308) - fix: drop shebang from bash completion template by [@barry3406](https://github.com/barry3406) in [#2317](urfave/cli#2317) - fix: show flag completions when completing a double-dash prefix by [@morozov](https://github.com/morozov) in [#2316](urfave/cli#2316) - fix: parse flags for help subcommand ([#2271](urfave/cli#2271)) by [@barry3406](https://github.com/barry3406) in [#2319](urfave/cli#2319) - fix: show BoolWithInverseFlag aliases in help text by [@wucm667](https://github.com/wucm667) in [#2321](urfave/cli#2321) #### New Contributors - [@gabelluardo](https://github.com/gabelluardo) made their first contribution in [#2298](urfave/cli#2298) - [@markshep-wbg](https://github.com/markshep-wbg) made their first contribution in [#2287](urfave/cli#2287) - [@lawrence3699](https://github.com/lawrence3699) made their first contribution in [#2309](urfave/cli#2309) - [@Yanhu007](https://github.com/Yanhu007) made their first contribution in [#2310](urfave/cli#2310) - [@alliasgher](https://github.com/alliasgher) made their first contribution in [#2311](urfave/cli#2311) - [@barry3406](https://github.com/barry3406) made their first contribution in [#2317](urfave/cli#2317) - [@morozov](https://github.com/morozov) made their first contribution in [#2316](urfave/cli#2316) - [@wucm667](https://github.com/wucm667) made their first contribution in [#2321](urfave/cli#2321) **Full Changelog**: <urfave/cli@v3.8.0...v3.9.0> </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At 12:00 AM through 04:59 AM and 10:00 PM through 11:59 PM, Monday through Friday (`* 0-4,22-23 * * 1-5`) - Only on Sunday and Saturday (`* * * * 0,6`) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://altlinux.space/stapler/stplr/pulls/432

barry3406 requested a review from a team as a code owner April 17, 2026 03:08

dearchap approved these changes Apr 18, 2026

View reviewed changes

dearchap merged commit 2925d6f into urfave:main Apr 18, 2026
9 checks passed

Navigation Menu

Repository navigation

fix: drop shebang from bash completion template - #2317

fix: drop shebang from bash completion template#2317
dearchap merged 1 commit into
urfave:mainfrom
barry3406:fix/completion-shebang

barry3406 commented Apr 17, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

barry3406 commented Apr 17, 2026

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Testing

Release Notes

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants