Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example for --skip-list in the help output #2946

Closed
mtausig opened this issue Jan 26, 2023 · 0 comments · Fixed by #2964
Closed

Add example for --skip-list in the help output #2946

mtausig opened this issue Jan 26, 2023 · 0 comments · Fixed by #2964
Assignees
Labels

Comments

@mtausig
Copy link

mtausig commented Jan 26, 2023

Summary

The --skip-list flag allows one to exclude certain rules via a command line switch, instead of using a configuration file.

Issue Type
  • Bug Report
OS / ENVIRONMENT
$ ansible-lint --version
ansible-lint 6.11.0 using ansible 2.13.7
  • OS: Ubuntu 20.04
  • ansible installation method: pip
  • ansible-lint installation method: pip
STEPS TO REPRODUCE

Starting ansible-lint with the --help switch shows the option to exclude certain rules

$ ansible-lint --help
...
-x SKIP_LIST, --skip-list SKIP_LIST
                        only check rules whose id/tags do not match these values
...

The format of the SKIP_LIST to be used is unfortunately not obvious if multiple values are to be used. It took me a while to discover the documentation of the correct format.
Other obvious formats, like putting the values in single or double ticks do not work.

Desired Behavior

Add a short example to the help output, e.g.,

$ ansible-lint --help
...
-x SKIP_LIST, --skip-list SKIP_LIST
                       e.g., --skip-list rule1,rule2
                        only check rules whose id/tags do not match these values
...
Actual Behavior

There is no example for using --skip-list with multiple values in the help output or the man page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants