help is not a supported command in --allow-commands

[andrusha]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

---

Overview of the Issue

#2877 introduced --allow-commands flag. It surprisingly does not recognize help command (see list of available commands), which is inconsistent with what is considered and acts like a command in Atlantis:

This potentially breaks Atlantis deployment and is annoying to manually fix afterwards.

Reproduction Steps

1. Run atlantis with --allow-commands help

Logs

Logs

 [31mError: invalid --allow-commands: unknown command name: help[39m

Environment details

• Atlantis version: 0.22.2
• Atlantis flags: ATLANTIS_ALLOW_COMMANDS: help

Additional Context

• feat: --allow-commands restricts available atlantis commands #2877
• https://github.com/krrrr38/atlantis/blob/0b360e107c6097c138a3ff44f8503bbd9dcf5fa2/server/events/command/name.go#L82-L100

[andrusha]

@krrrr38 @nitrocode @chenrui333 take a look, please.

[nitrocode]

@andrusha if you do not set allow-commands to help, or setting it to plan, does commenting atlantis help on a PR work?

@krrrr38 and I did speak about the Atlantis help command briefly within that PR. I think it does work but it may not be accessible from --allow-commands.

I believe the information that comes from help is not an explicitly defined command, more of a default if a subcommand is not found.

[krrrr38]

I think we don't need to do anything. Because
available allow commads are written in docs and server returns correct error message.
https://www.runatlantis.io/docs/server-configuration.html#allow-commands

Do you want to disable help command in your usecase? @andrusha

---

First of all, thank you for using new feature and submit issue!

[andrusha]

@nitrocode I don't think help works when --allow-commands option is set, at least not from Github comments.

Either way even if it's a special from within the application I think it makes sense to not fail on it being an input to allow-commands, as it is confusing to people not familiar with Atlantis internals.