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

fix: change capitalisation of "pod" and "etcd" throughout #513

Merged
merged 3 commits into from
Oct 4, 2023
Merged

Conversation

craigbox
Copy link
Contributor

@craigbox craigbox commented Oct 2, 2023

PR Type:

Refactoring


PR Description:

This PR standardizes the capitalization of 'pod' and 'etcd' across various files in the codebase. Previously, these terms were inconsistently capitalized, sometimes appearing as 'POD' or 'ETCD'. The changes mainly involve updating descriptions, remediations, and long descriptions in various control files, as well as some instances in the README and framework files. The PR aims to improve readability and consistency in the codebase.


PR Main Files Walkthrough:

files:

controls/C-0075-imagepullpolicyonlatesttag.json: Updated the capitalization of 'pod' in the description, remediation, and long_description fields.
frameworks/cis-eks-t1.2.0.json: Corrected the capitalization of 'etcd' in the manual_test field.
controls/C-0073-nakedpods.json: Changed the capitalization of 'pod' in the name, description, remediation, and long_description fields.
controls/C-0009-resourcelimits.json: Updated the capitalization of 'pod' in the description, remediation, and long_description fields.
README.md: Corrected the capitalization of 'pod' in the example control and its description.
controls/C-0038-hostpidipcprivileges.json: Updated the capitalization of 'pod' in the description and long_description fields.
controls/C-0056-configuredlivenessprobe.json: Corrected the capitalization of 'pod' in the description and long_description fields.
controls/C-0061-podsindefaultnamespace.json: Updated the capitalization of 'pod' in the description, remediation, and long_description fields.
controls/C-0034-automaticmappingofserviceaccount.json: Corrected the capitalization of 'pod' in the description and remediation fields.
controls/C-0048-hostpathmount.json: Updated the capitalization of 'pod' in the description field.


User Description:

POD and ETCD aren't acronyms, so they should never be SHOUTED written in all caps.

This PR is a very considered search and replace across the library. KUBELET_SYSTEM_PODS_ARGS should remain in caps, for example.

This is my third attempt. Please merge this one quickly!

Signed-off-by: Craig Box craigb@armosec.io

Signed-off-by: Craig Box <craigb@armosec.io>
@codiumai-pr-agent-free
Copy link
Contributor

PR Analysis

  • 🎯 Main theme: Standardizing the capitalization of 'pod' and 'etcd' across various files in the codebase
  • 📝 PR summary: This PR aims to improve readability and consistency in the codebase by standardizing the capitalization of 'pod' and 'etcd'. The changes involve updating descriptions, remediations, and long descriptions in various control files, as well as some instances in the README and framework files.
  • 📌 Type of PR: Refactoring
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 1
    The PR is straightforward and only involves changes in text capitalization. No complex code changes or additions are involved.
  • 🔒 Security concerns: No security concerns found

PR Feedback

  • 💡 General suggestions: The PR is well-structured and the changes made are consistent. The standardization of 'pod' and 'etcd' across the codebase improves readability and consistency. No major issues were found.

  • 🤖 Code feedback:

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Summary:

  • License scan: failure
  • Credentials scan: success
  • Vulnerabilities scan: failure
  • Unit test: success
  • Go linting: success

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Summary:

  • License scan: failure
  • Credentials scan: success
  • Vulnerabilities scan: failure
  • Unit test: success
  • Go linting: success

@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2023

Summary:

  • License scan: failure
  • Credentials scan: success
  • Vulnerabilities scan: failure
  • Unit test: success
  • Go linting: success

@craigbox craigbox merged commit 8da97f9 into master Oct 4, 2023
26 checks passed
@craigbox craigbox deleted the pod-etcd branch October 4, 2023 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants