Add codespell check to PR lint action

keithpine commented 1 year ago

Description

Add codespell action to PR/push workflow, to improve PR and code quality.

Type of change

[ ] Bug fix (non-breaking change that fixes an issue)
[ ] New feature (non-breaking change that adds new functionality)
[ ] Breaking change (bug fix or new feature that breaks existing functionality)
[ ] Third-party dependency update
[ ] Documentation additions or improvements
[X] Code quality improvements to existing code or test additions/updates

How was this tested?

Observed spellcheck is run during PR lint job.

For the cloudformation change, ran the script before and after change and observed the output was identical.

Additional information

Basically using the default codespell action configuration with some words being ignored.

Checklist

[ ] The change is tested and works locally.
[ ] New or changed settings in the solution YAML are documented clearly in the README.md file.
[X] All commits are signed off and are in agreement with the CORTX Community DCO and CLA policy.

If this change requires newer CORTX or third party image versions:

[ ] The image fields in solution.example.yaml have been updated to use the required versions.
[ ] The appVersion field of the Helm chart has been updated to use the new CORTX version.

If this change addresses a CORTX Jira issue:

[ ] The title of the PR starts with the issue ID (e.g. CORTX-XXXXX:)

keithpine commented 1 year ago

I submitted a Jira to fork the action repo. We can either wait for that to occur and I'll update the PR, or merge now and I'll update when it's available.

osowski commented 1 year ago

I submitted a Jira to fork the action repo. We can either wait for that to occur and I'll update the PR, or merge now and I'll update when it's available.

This looks good. I'd prefer to wait for the fork to get created and just update the GitHub Actions flow once (instead of coming back to it later).

keithpine commented 1 year ago

This looks good. I'd prefer to wait for the fork to get created and just update the GitHub Actions flow once (instead of coming back to it later).

That's fine with me. Though it does mean catch-able spelling errors may be introduced until then. ;)

Seagate / cortx-k8s