Skip to content

[WIP] Ansible-lint: Add example config for github action #612

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.

Sign up for GitHub

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

Open
MarkusTeufelberger wants to merge 17 commits into
base: main
Choose a base branch
from
Open

[WIP] Ansible-lint: Add example config for github action #612

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
01f5602
Ansible-lint: Add example config for github action
May 31, 2023
e3936e0
ansible-lint: use different repo for action
May 31, 2023
d73085b
ansible-lint: check out repo before linting it
May 31, 2023
9c76574
ansible-lint: ignore all existing problems
May 31, 2023
062a3da
Update .ansible-lint with file header
May 31, 2023
aadbca6
ansible-lint: github workflow files contain a truthy value by design
May 31, 2023
6fcb8ec
ansible-lint: rename a reserved variable name
May 31, 2023
cc04f4c
ansible-lint: add 2 more ignores that are relevant in 6.17.0
May 31, 2023
4f25aca
ansible-lint: Use better workaround for truthy yaml keys
Jun 6, 2023
a182f21
ansible-lint: fix missing newline at end of file
Jun 6, 2023
e3d0a4b
ansible-lint: fix trailing spaces
Jun 6, 2023
57ae17d
ansible-lint: fix indentation of some comments
Jun 6, 2023
f088fac
ansible-lint: remove empty line
Jun 6, 2023
59e0a74
ansible-lint: Name all plays
Jun 6, 2023
852ca2c
ansible-lint: remove spaces inside some brackets
Jun 6, 2023
f88839d
ansible-lint: add missing task name to satisfy tasks schema
Jun 6, 2023
13396dd
switch back to main repo and use per-file ignores instead of global ones
Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .ansible-lint
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
skip_list:
# TODO: Fix and enable one-by-one over time
Copy link
Contributor

@felixfontein felixfontein May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But only the ones that make sense. sanity[cannot-ignore] looks pretty much wrong, for example.

Copy link
Contributor Author

@MarkusTeufelberger MarkusTeufelberger May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope that the eventual goal is to have both the collection(s) and ansible-lint rules in a state that no rule skips or any changes to default configs are necessary. For sanity[cannot-ignore] for example I am hardlocked on ansible/ansible#79700 making it into ansible-core and every version of ansible-core falling out of support until I can disable this in my collection. Similar with the shebangs in this repo here apparently?

There are some easy wins with fixing the long tail of errors (end of line whitespace and such) and automatic rewrites could be used or introduced for some things too. There are however also some issues with that (e.g. ansible/ansible-lint#3226 will hit every collection created from the default template).

- command-instead-of-module
- command-instead-of-shell
- key-order[task]
- jinja[spacing]
- no-free-form
- schema[galaxy]
- schema[tasks]
- name[missing]
- name[play]
- var-naming[no-role-prefix]
- var-naming[pattern]
- yaml[brackets]
- yaml[comments]
- yaml[empty-lines]
- yaml[indentation]
- yaml[line-length]
- yaml[new-line-at-end-of-file]
- yaml[trailing-spaces]
- name[template]
- name[casing]
- risky-file-permissions
- risky-shell-pipe
- galaxy[tags]
- ignore-errors
- no-changed-when
- no-handler
- sanity[cannot-ignore]
- fqcn[action-core]
18 changes: 18 additions & 0 deletions .github/workflows/ansible-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later

name: ansible-lint
on:
pull_request:
branches: ["main", "stable-*"]
jobs:
build:
name: Ansible Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Run ansible-lint
Copy link
Contributor

@felixfontein felixfontein Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A checkout step needs to be added before here. There was a breaking change in the action that started requiring that.

uses: ansible/ansible-lint-action@v6