feat: (IAC-1066) Add Hadolint, ShellCheck TFLint Checks, and Ansible Lint via GitHub Actions #78
Conversation
| - role-name # roles are dynamically selected based on user's choice so we do need to use paths | ||
| - yaml[line-length] # it's easier to understand/debug the underlying command when it's not broken up, excessively long lines that make sense to split up should be caught during code review, | ||
| - name[template] # task name is being templated, this can be ignored | ||
| - command-instead-of-shell # shell should only be used when necessary, swap to command TODO future update requires functionality change |
There was a problem hiding this comment.
Note:
Ignoring command-instead-of-shell, command-instead-of-module, and deprecated-module linting warnings for now. To resolve these linter warnings it requires a change of functionality which I was trying to avoid with this PR. I've created a Jira ticket to address these as part of a future sprint. These are not breaking or high priority warnings that need immediate attention, just nice to have.
There was a problem hiding this comment.
IAC-1088, for any internal users seeing this.
jarpat
added
documentation
| vars: | ||
| option: systemd.unified_cgroup_hierarchy | ||
| value: "1" | ||
| tags: | ||
| - install |
There was a problem hiding this comment.
I believe this was in place for Ubuntu 20.04 LTS has this been moved? Or if it's not needed for Ubuntu 22.04 LTS then we need to put guards on this. I have this in my own sandbox to fix this. NOTE: The version is based on when this was fixed.
vars:
option: systemd.unified_cgroup_hierarchy
value: "1"
when:
- ansible_distribution == "Ubuntu" and ansible_distribution_version is version('21.10', '<', strict=true)
tags:
- installThere was a problem hiding this comment.
The git diff makes it looks like items were removed as part of the format update.
What happened on these lines was that order of keys in the task were updated to follow ansible conventions as part of this rule:
https://ansible.readthedocs.io/projects/lint/rules/key-order/
So previously the order was name>block>vars>tag and it's been updated to names>vars>tags>block
No real functionality change was made here, just the order was updated. The git diff makes it look like items were removed.
If you take a look at the code in the branch it'll be easier to see the changes https://github.com/sassoftware/viya4-iac-k8s/blob/IAC-1066/roles/kubernetes/common/tasks/main.yaml#L41-L93
Changes
Enabled linting of the viya4-iac-k8s project with
Hadolint,ShellCheck,TFLint, andAnsible Lintthrough a workflow in GitHub actions. Once the workflow was configured, any errors or warnings raised was resolved as part of this PR.No change in functionality has been made with this PR mostly formatting,
Tests