Skip to content

docs: update naming style from imperative to declarative#491

Merged
tenthirtyam merged 1 commit intovmware:mainfrom
stevewallone:declarative-terraform
Mar 10, 2025
Merged

docs: update naming style from imperative to declarative#491
tenthirtyam merged 1 commit intovmware:mainfrom
stevewallone:declarative-terraform

Conversation

@stevewallone
Copy link
Copy Markdown
Contributor

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
Copy Markdown

@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 <john.doe@email.org> 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
@vmwclabot vmwclabot removed the dco-required DCO Required label Jan 16, 2025
@codecov-commenter
Copy link
Copy Markdown

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
Copy Markdown
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
Copy Markdown
Contributor Author

@vivgoyal giving this a bump for a review.

Signed-off-by: Steve Wall <steven.wall@capstonec.com>
@stevewallone
Copy link
Copy Markdown
Contributor Author

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

@stevewallone
Copy link
Copy Markdown
Contributor 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
Copy Markdown
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
@vivgoyal
Copy link
Copy Markdown
Contributor

vivgoyal commented Mar 6, 2025

Sorry for the delay. Just came back from PTO today.

@tenthirtyam tenthirtyam merged commit 4e12da7 into vmware:main Mar 10, 2025
@tenthirtyam tenthirtyam removed the needs-review Needs Review label Mar 10, 2025
@stevewallone
Copy link
Copy Markdown
Contributor Author

Thanks for making this happen! Should I move forward deleting the branch?

@tenthirtyam
Copy link
Copy Markdown
Contributor

Yep!

@github-actions
Copy link
Copy Markdown

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Terraform Naming Convention

5 participants