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

chore: remove stutters #59

Merged
merged 1 commit into from
Jan 24, 2025
Merged

chore: remove stutters #59

merged 1 commit into from
Jan 24, 2025

Conversation

tenthirtyam
Copy link
Contributor

In order to have a good experience with our community, we recommend that you read the contributing guidelines for making a pull request.

Summary of Pull Request

Renames several types and functions to improve consistency and clarity in the codebase. The most important changes include renaming the HcxCloudAuthorizationBody struct and the HcxCloudAuthenticate function, and updating their references in the resource_vmc.go file.

~/Code/terraform-provider-hcx git:[chore/errcount-shorthand]
make lint | grep stutter
hcx/vmc.go:43:6: exported: type name will be used as hcx.HcxCloudAuthorizationBody by other packages, and that stutters; consider calling this CloudAuthorizationBody (revive)
hcx/vmc.go:90:6: exported: func name will be used as hcx.HcxCloudAuthenticate by other packages, and that stutters; consider calling this CloudAuthenticate (revive)
make: *** [lint] Error 1

Renaming:

  • hcx/vmc.go: Renamed HcxCloudAuthorizationBody to CloudAuthorizationBody and updated its usage in the CloudAuthenticate function. [1] [2]
  • hcx/vmc.go: Renamed HcxCloudAuthenticate to CloudAuthenticate and updated its implementation to use the new CloudAuthorizationBody struct.

Updated References:

  • resource_vmc.go: Updated references to the renamed CloudAuthenticate function in the resourceVmcCreate, resourceVmcRead, and resourceVmcDelete functions. [1] [2] [3]

Type of Pull Request

  • 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:

Related to Existing Issues

Ref: #42

Test and Documentation Coverage

For bug fixes or features:

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

Breaking Changes?

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

@tenthirtyam tenthirtyam added chore Chore technical-debt Technical Debt labels Jan 23, 2025
@tenthirtyam tenthirtyam added this to the .next milestone Jan 23, 2025
@tenthirtyam tenthirtyam self-assigned this Jan 23, 2025
@github-actions github-actions bot added the needs-review Needs Review label Jan 23, 2025
@tenthirtyam tenthirtyam linked an issue Jan 23, 2025 that may be closed by this pull request
@tenthirtyam tenthirtyam requested a review from andybeltz January 23, 2025 22:22
Copy link

@andybeltz andybeltz left a comment

Choose a reason for hiding this comment

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

LGTM!

- Updates `HcxCloudAuthorizationBody` to `CloudAuthorizationBody`.
- Updates `HcxCloudAuthenticate` to `CloudAuthenticate`.

Ref: #42

Signed-off-by: Ryan Johnson <[email protected]>
@tenthirtyam tenthirtyam force-pushed the chore/remove-stutters branch from 8edc8d5 to 569e717 Compare January 24, 2025 03:04
@tenthirtyam tenthirtyam merged commit a6677cf into main Jan 24, 2025
3 checks passed
@tenthirtyam tenthirtyam deleted the chore/remove-stutters branch January 24, 2025 03:04
@tenthirtyam tenthirtyam removed the needs-review Needs Review label Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Chore technical-debt Technical Debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Address linting ssues
2 participants