ci/docs/make: Bring balance to the force (ci/make parity)

[YakDriver]

Description

This pull request brings several improvements and updates to our project. The changes aim to ensure consistency between local development workflows and CI processes, correct minor issues, enhance documentation, and update dependencies to avoid potential errors. Below is a detailed breakdown of the modifications made:

Changes

1. Align CI Workflows with Makefile Functionality: Modified the Makefile to mirror the checks and processes run in CI workflows. This ensures that developers can run the same checks locally as those executed during CI, promoting consistency, convenience, and reliability.

2. Fix Spelling Mistake in Makefile Generator: Corrected a spelling error in the generator script affecting the creation of Makefiles. This fix ensures that generated Makefiles are free from typographical errors, improving readability and reducing potential confusion.

3. Makefile Cleanup: Refactored the Makefile to use consistent variables and arguments throughout. This cleanup simplifies the Makefile structure, making it easier to read and maintain.

4. Update tfproviderlint Tool Version: Updated the tfproviderlint tool to the latest version. This update addresses errors arising from provider-defined functions, enhancing compatibility and stability.

5. Documentation Additions:

   • Added detailed documentation explaining the use of Go-standard mixed caps versus camel case. This addition aims to clarify coding conventions and promote best practices among contributors.
   • Included new documentation for contributors on how to write and run unit tests. This guidance is intended to assist new contributors in adhering to our testing standards and improving the overall quality of code submissions.

6. Standardize Makefile Targets: Standardized the naming convention for Makefile targets to use dashes between words. This change aligns with common conventions and improves the readability and consistency of our build scripts.

Detailed File Changes

1. .github/workflows: Updated Makefile/ci to invoke the same functionality (balance to the force).
2. Generators: Corrected the spelling mistake that affected many generated files.
3. Makefile:
   • Refactored to use consistent variable names and argument formats.
   • Standardized target names to use dashes between words.
4. tools/tfproviderlint: Updated to the latest version to avoid errors related to provider-defined functions.
5. docs/naming.md: Added a new section detailing the use of mixed caps versus camel case in Go code.
6. docs/unit-tests.md: Added a new document providing guidelines for writing and running unit tests.

Impact

These changes collectively enhance the maintainability, readability, and consistency of our codebase and build processes. By aligning local and CI workflows, we reduce the likelihood of environment-specific issues. The documentation updates and standardization efforts support contributors in following established conventions and best practices.

Testing

• All modified CI workflows have been tested to ensure they execute the intended Makefile targets correctly.
• Generated Makefiles have been verified to confirm the spelling correction.
• The updated tfproviderlint tool has been tested to ensure compatibility and error-free operation.
• Documentation additions have been reviewed for accuracy and clarity.

Additional Notes

• Contributors are encouraged to review the new documentation sections to familiarize themselves with the updated conventions and guidelines.
• Please report any issues or suggestions for further improvements.

Relations

Closes #0000

References

Output from Acceptance Testing

% make testacc TESTS=TestAccXXX PKG=ec2

...

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

• Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
• For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
• Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

[github-actions]

Thank you for your contribution! 🚀

A new usage of AWS SDK for Go V1 was detected. Please prefer AWS SDK for Go V2 for all net-new services. If this is an enhancement or bug fix to an existing AWS SDK Go V1 based resource, this comment can be safely ignored.

For additional information refer to the AWS SDK for Go Versions page in the contributor guide.