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

docs: update naming style from imperative to declarative #491

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stevewallone
Copy link

Summary

The terraform files use an imperative style, i.e. create_tkg_cluster. The convention is to use a declarative style that doesn't imply an actions, i.e. tkg_cluster.

Type

  • This is a bug fix.
  • This is an enhancement or feature.
  • This is a code style/formatting update.
  • This is a documentation update.
  • This is a refactoring update.
  • This is a chore update
  • This is something else.
    Please describe:

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

Test and Documentation

  • Tests have been completed.
  • Documentation has been added or updated.

Issue References

Resolves #482

Additional Information

@vmwclabot
Copy link
Member

@stevewallone, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

@vmwclabot vmwclabot added the dco-required DCO Required label Jan 16, 2025
@github-actions github-actions bot added documentation Documentation needs-review Needs Review labels Jan 16, 2025
@stevewallone stevewallone force-pushed the declarative-terraform branch from d216f4a to 2cff4ef Compare January 16, 2025 21:50
@vmwclabot vmwclabot removed the dco-required DCO Required label Jan 16, 2025
@codecov-commenter
Copy link

codecov-commenter commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.96%. Comparing base (3578fd2) to head (f4738bf).
Report is 79 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (3578fd2) and HEAD (f4738bf). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (3578fd2) HEAD (f4738bf)
2 1
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #491      +/-   ##
==========================================
- Coverage   25.23%   19.96%   -5.27%     
==========================================
  Files         195      264      +69     
  Lines       16908    23632    +6724     
==========================================
+ Hits         4267     4719     +452     
- Misses      12423    18699    +6276     
+ Partials      218      214       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tenthirtyam tenthirtyam changed the title Change terraform file style from imperative to declarative #482 docs: update naming style from imperative to declarative Jan 21, 2025
Copy link
Contributor

@tenthirtyam tenthirtyam left a comment

Choose a reason for hiding this comment

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

LGTM

@stevewallone
Copy link
Author

@vivgoyal giving this a bump for a review.

@tenthirtyam tenthirtyam force-pushed the declarative-terraform branch from 2cff4ef to f4738bf Compare January 24, 2025 15:54
@stevewallone
Copy link
Author

@vivgoyal Sorry to bother you with this, but if you could give this a review that would great!

@stevewallone
Copy link
Author

Giving a bump for visibility. @vivgoyal would a bottle of scotch help? Maybe bourbon? Some good wine? I'll do whatever it takes. ;-)

@tenthirtyam
Copy link
Contributor

Hi @stevewallone 👋🏻 - Vivek is out of office currently, but I've shared a reminder internally for return.

@tenthirtyam tenthirtyam added this to the .next milestone Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation needs-review Needs Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Terraform Naming Convention
4 participants