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

remove API coverage section from readme file. It hasn't been used or … #1033

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

uturunku1
Copy link
Collaborator

@uturunku1 uturunku1 commented Jan 13, 2025

…updated since it was added

Description

Reasons to remove the API coverage section from the README in go-tfe:

  • The remaining APIs on that list will never be supported.

  • We haven't updated this section as new APIs are introduced.

  • Users of go-tfe don’t seem to be paying any attention to this section since the section was introduced. They haven't asked questions about it or even noticed that we haven't kept it up to date.

Testing plan

External links

Output from tests

Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.

$ TFE_ADDRESS="https://example" TFE_TOKEN="example" go test ./... -v -run TestFunctionsAffectedByChange

...

@uturunku1 uturunku1 requested a review from a team as a code owner January 13, 2025 17:57
@datadog-terraform-cloud-hashicorp

Datadog Report

Branch report: update-doc
Commit report: d587832
Test service: hashicorp/go-tfe

✅ 0 Failed, 1421 Passed, 159 Skipped, 15m 42.75s Total Time
➡️ Test Sessions change in coverage: 1 no change

@uturunku1 uturunku1 merged commit 6aa1267 into main Jan 13, 2025
8 checks passed
@uturunku1 uturunku1 deleted the update-doc branch January 13, 2025 18:24
Copy link

Reminder to the contributor that merged this PR: if your changes have added important functionality or fixed a relevant bug, open a follow-up PR to update CHANGELOG.md with a note on your changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants