Skip to content

Commit

Permalink
Merge pull request #392 from hashicorp/brandonc/relocate-coverage
Browse files Browse the repository at this point in the history
relocate coverage
  • Loading branch information
brandonc committed May 16, 2022
2 parents e7a3c10 + 68d1dba commit 1241af2
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 62 deletions.
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ _Include any links here that might be helpful for people reviewing your PR. If t
-->

## Output from tests (HashiCorp employees only)
## 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.

<!--
_Please run the tests locally for any files you changes and include the output here._
Expand Down
65 changes: 63 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,68 @@ For complete usage of the API client, see the [full package docs](https://pkg.go

## API Coverage

This API client covers most of the existing Terraform Cloud API calls and is updated regularly to add new or missing endpoints. For a complete list of what is supported/unsupported, please [refer to this page](docs/COVERAGE.md).
This API client covers most of the existing Terraform Cloud API calls and is updated regularly to add new or missing endpoints.

- [x] Account
- [x] Agent Pools
- [x] Agent Tokens
- [x] Applies
- [ ] Audit Trails
- [x] Changelog
- [x] Comments
- [x] Configuration Versions
- [x] Cost Estimation
- [ ] Feature Sets
- [ ] Invoices
- [x] IP Ranges
- [x] Notification Configurations
- [x] OAuth Clients
- [x] OAuth Tokens
- [x] Organizations
- [x] Organization Memberships
- [x] Organization Tags
- [x] Organization Tokens
- [x] Plan Exports
- [x] Plans
- [x] Policies
- [x] Policy Checks
- [x] Policy Sets
- [x] Policy Set Parameters
- [ ] Private Registry
- [x] Modules
- [ ] Providers
- [ ] Provider Provider Versions and Platforms
- [ ] GPG Keys
- [x] Runs
- [x] Run Tasks
- [ ] Run Tasks Integration
- [x] Run Triggers
- [x] SSH Keys
- [x] Stability Policy
- [x] State Versions
- [x] State Version Outputs
- [ ] Subscriptions
- [x] Team Access
- [x] Team Membership
- [x] Team Tokens
- [x] Teams
- [x] User Tokens
- [x] Users
- [x] Variable Sets
- [x] Variables
- [ ] VCS Events
- [x] Workspaces
- [x] Workspace-Specific Variables
- [x] Workspace Resources
- [x] Admin
- [x] Module Sharing
- [x] Organizations
- [x] Runs
- [x] Settings
- [x] Terraform Versions
- [x] Users
- [x] Workspaces


## Examples

Expand All @@ -76,4 +137,4 @@ See [CONTRIBUTING.md](docs/CONTRIBUTING.md)

## Releases

See [RELEASES.md](docs/RELEASES.md)
See [RELEASES.md](docs/RELEASES.md)
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you find an issue with this package, please create an issue in GitHub. If you

## Adding new functionality or fixing relevant bugs

If you are adding a new endpoint, make sure to update COVERAGE.md where we keep a list of the TFC APIs that this SDK supports.
If you are adding a new endpoint, make sure to update the [coverage list in README.md](../README.md#API-Coverage) where we keep a list of the TFC APIs that this SDK supports.

If you are making relevant changes that is worth communicating to our users, please include a note about it in our CHANGELOG.md. You can include it as part of the PR where you are submitting your changes.

Expand Down Expand Up @@ -33,7 +33,7 @@ mockgen -source=example_resource.go -destination=mocks/example_resource_mocks.go

## Adding API changes that are still behind a feature flag

On top of your code changes, or anywhere visible, add a comment that reads like this:
On top of your code changes, or anywhere visible, add a comment that reads like this:

```
// **Note: This field is still in BETA and subject to change.**
Expand Down
57 changes: 0 additions & 57 deletions docs/COVERAGE.md

This file was deleted.

0 comments on commit 1241af2

Please sign in to comment.