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

Rebrand Terraform Cloud to HCP Terrraform #891

Merged
merged 1 commit into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Hi there,

Thank you for opening an issue! Please note that we try to keep the this issue
tracker reserved for bug reports and feature requests related to the go-tfe API
wrapper. If you know your issue relates to the Terraform Cloud/Enterprise
wrapper. If you know your issue relates to the HCP Terraform and Terraform Enterprise
platform itself, please contact tf-cloud@hashicorp.support. For general usage
questions, please post to our community forum: https://discuss.hashicorp.com.
-->
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

blank_issues_enabled: false
contact_links:
- name: Terraform Cloud/Enterprise Troubleshooting and Feature Requests
- name: HCP Terraform and Terraform Enterprise Troubleshooting and Feature Requests
url: https://support.hashicorp.com/hc/en-us/requests/new
about: For issues and feature requests concerning the Terraform Cloud/Enterprise platform itself, please submit a HashiCorp support request or email tf-cloud@hashicorp.support
about: For issues and feature requests concerning the HCP Terraform and Terraform Enterprise platform itself, please submit a HashiCorp support request or email tf-cloud@hashicorp.support
- name: Terraform Language or Workflow Questions
url: https://discuss.hashicorp.com
about: Please ask Terraform language or workflow related questions through the HashiCorp Discuss forum
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Hi there,

Thank you for opening an issue! Please note that we try to keep the this issue tracker reserved for
bug reports and feature requests related to the go-tfe API wrapper. If you know
your issue relates to the Terraform Cloud/Enterprise platform itself, please contact
your issue relates to the HCP Terraform and Terraform Enterprise platform itself, please contact
tf-cloud@hashicorp.support. For general usage questions, please post to our community forum:
https://discuss.hashicorp.com.
-->
Expand Down
18 changes: 9 additions & 9 deletions .github/actions/test-go-tfe/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,31 @@ inputs:
description: Total number of matrix strategy runners
required: true
address:
description: Address of the Terraform Cloud instance to test against
description: Address of the HCP Terraform instance to test against
required: true
admin_configuration_token:
description: TFC Admin API Configuration role token
description: HCP Terraform Admin API Configuration role token
required: true
admin_provision_licenses_token:
description: TFC Admin API Provision Licenses role token
description: HCP Terraform Admin API Provision Licenses role token
required: true
admin_security_maintenance_token:
description: TFC Admin API Security Maintenance role token
description: HCP Terraform Admin API Security Maintenance role token
required: true
admin_site_admin_token:
description: TFC Admin API Site Admin role token
description: HCP Terraform Admin API Site Admin role token
required: true
admin_subscription_token:
description: TFC Admin API Subscription role token
description: HCP Terraform Admin API Subscription role token
required: true
admin_support_token:
description: TFC Admin API Support role token
description: HCP Terraform Admin API Support role token
required: true
admin_version_maintenance_token:
description: TFC Admin API Version Maintenance role token
description: HCP Terraform Admin API Version Maintenance role token
required: true
token:
description: Terraform Cloud token
description: HCP Terraform token
required: true
oauth-client-github-token:
description: The GitHub token used for testing OAuth scenarios for VCS workspaces
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Thank you for contributing to hashicorp/go-tfe! Please read docs/CONTRIBUTING.md

Here's what to expect after the pull request is opened:

The test suite contains many acceptance tests that are run against a test version of Terraform Cloud, and additional testing is done against Terraform Enterprise. You can read more about running the tests against your own Terraform Enterprise environment in TESTS.md. Our CI system (Github Actions) will not test your fork until a one-time approval takes place.
The test suite contains many acceptance tests that are run against a test version of HCP Terraform, and additional testing is done against Terraform Enterprise. You can read more about running the tests against your own Terraform Enterprise environment in TESTS.md. Our CI system (Github Actions) will not test your fork until a one-time approval takes place.

Your change, depending on its impact, may be released in the following ways:

Expand Down
2 changes: 1 addition & 1 deletion META.d/_summary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ category: library

summary:
owner: team-tf-cli
description: Terraform Cloud/Enterprise API Client/SDK in Golang
description: HCP Terraform and Terraform Enterprise API Client/SDK in Golang
visibility: external
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Terraform Cloud/Enterprise Go Client
HCP Terraform and Terraform Enterprise Go Client
==============================

[![Tests](https://github.com/hashicorp/go-tfe/actions/workflows/ci.yml/badge.svg)](https://github.com/hashicorp/go-tfe/actions/workflows/ci.yml)
Expand All @@ -7,11 +7,11 @@ Terraform Cloud/Enterprise Go Client
[![Go Report Card](https://goreportcard.com/badge/github.com/hashicorp/go-tfe)](https://goreportcard.com/report/github.com/hashicorp/go-tfe)
[![GitHub issues](https://img.shields.io/github/issues/hashicorp/go-tfe.svg)](https://github.com/hashicorp/go-tfe/issues)

The official Go API client for [Terraform Cloud/Enterprise](https://www.hashicorp.com/products/terraform).
The official Go API client for [HCP Terraform and Terraform Enterprise](https://www.hashicorp.com/products/terraform).

This client supports the [Terraform Cloud V2 API](https://developer.hashicorp.com/terraform/cloud-docs/api-docs).
As Terraform Enterprise is a self-hosted distribution of Terraform Cloud, this
client supports both Cloud and Enterprise use cases. In all package
This client supports the [HCP Terraform V2 API](https://developer.hashicorp.com/terraform/cloud-docs/api-docs).
As Terraform Enterprise is a self-hosted distribution of HCP Terraform, this
client supports both HCP Terraform and Terraform Enterprise use cases. In all package
documentation and API, the platform will always be stated as 'Terraform
Enterprise' - but a feature will be explicitly noted as only supported in one or
the other, if applicable (rare).
Expand Down Expand Up @@ -56,8 +56,8 @@ if err != nil {
### Using the default config with env vars
The default configuration makes use of the `TFE_ADDRESS` and `TFE_TOKEN` environment variables.

1. `TFE_ADDRESS` - URL of a Terraform Cloud or Terraform Enterprise instance. Example: `https://tfe.local`
1. `TFE_TOKEN` - An [API token](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/api-tokens) for the Terraform Cloud or Terraform Enterprise instance.
1. `TFE_ADDRESS` - URL of a HCP Terraform or Terraform Enterprise instance. Example: `https://tfe.local`
1. `TFE_TOKEN` - An [API token](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/api-tokens) for the HCP Terraform or Terraform Enterprise instance.

**Note:** Alternatively, you can set `TFE_HOSTNAME` which serves as a fallback for `TFE_ADDRESS`. It will only be used if `TFE_ADDRESS` is not set and will resolve the host to an `https` scheme. Example: `tfe.local` => resolves to `https://tfe.local`

Expand Down Expand Up @@ -115,7 +115,7 @@ 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.
This API client covers most of the existing HCP Terraform API calls and is updated regularly to add new or missing endpoints.

- [x] Account
- [x] Agents
Expand Down
2 changes: 1 addition & 1 deletion admin_workspace_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (

// BEWARE: The admin workspaces API can view all of the workspaces created by
// EVERY test organization in EVERY concurrent test run (or other usage) for the
// current TFC instance. It's generally not safe to assume that the workspaces
// current HCP Terraform instance. It's generally not safe to assume that the workspaces
// you create in a given test will be within the first page of list results, so
// you might have to get creative and/or settle for less when testing the
// behavior of these endpoints.
Expand Down
4 changes: 2 additions & 2 deletions agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
var _ Agents = (*agents)(nil)

// Agents describes all the agent-related methods that the
// Terraform Cloud API supports.
// HCP Terraform API supports.
// TFE API docs: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/agents
type Agents interface {
// Read an agent by its ID.
Expand All @@ -35,7 +35,7 @@ type AgentList struct {
Items []*Agent
}

// Agent represents a Terraform Cloud agent.
// Agent represents a HCP Terraform agent.
type Agent struct {
ID string `jsonapi:"primary,agents"`
Name string `jsonapi:"attr,name"`
Expand Down
6 changes: 3 additions & 3 deletions agent_pool.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import (
// Compile-time proof of interface implementation.
var _ AgentPools = (*agentPools)(nil)

// AgentPools describes all the agent pool related methods that the Terraform
// Cloud API supports. Note that agents are not available in Terraform Enterprise.
// AgentPools describes all the agent pool related methods that the HCP Terraform
// API supports. Note that agents are not available in Terraform Enterprise.
//
// TFE API docs: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/agents
type AgentPools interface {
Expand Down Expand Up @@ -50,7 +50,7 @@ type AgentPoolList struct {
Items []*AgentPool
}

// AgentPool represents a Terraform Cloud agent pool.
// AgentPool represents a HCP Terraform agent pool.
type AgentPool struct {
ID string `jsonapi:"primary,agent-pools"`
Name string `jsonapi:"attr,name"`
Expand Down
4 changes: 2 additions & 2 deletions agent_token.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
var _ AgentTokens = (*agentTokens)(nil)

// AgentTokens describes all the agent token related methods that the
// Terraform Cloud API supports.
// HCP Terraform API supports.
//
// TFE API docs:
// https://developer.hashicorp.com/terraform/cloud-docs/api-docs/agent-tokens
Expand All @@ -37,7 +37,7 @@ type agentTokens struct {
client *Client
}

// AgentToken represents a Terraform Cloud agent token.
// AgentToken represents a HCP Terraform agent token.
type AgentToken struct {
ID string `jsonapi:"primary,authentication-tokens"`
CreatedAt time.Time `jsonapi:"attr,created-at,iso8601"`
Expand Down
10 changes: 5 additions & 5 deletions audit_trail.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ import (
// Compile-time proof of interface implementation
var _ AuditTrails = (*auditTrails)(nil)

// AuditTrails describes all the audit event related methods that the Terraform
// Cloud API supports.
// AuditTrails describes all the audit event related methods that the HCP Terraform
// API supports.
// **Note:** These methods require the client to be configured with an organization token for
// an organization in the Business tier. Furthermore, these methods are only available in Terraform Cloud.
// an organization in the Business tier. Furthermore, these methods are only available in HCP Terraform.
//
// TFC API Docs: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/audit-trails
// HCP Terraform API Docs: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/audit-trails
type AuditTrails interface {
// Read all the audit events in an organization.
List(ctx context.Context, options *AuditTrailListOptions) (*AuditTrailList, error)
Expand Down Expand Up @@ -63,7 +63,7 @@ type AuditTrailPagination struct {
TotalCount int `json:"total_count"`
}

// AuditTrail represents an event in the TFC audit log.
// AuditTrail represents an event in the HCP Terraform audit log.
type AuditTrail struct {
ID string `json:"id"`
Version string `json:"version"`
Expand Down
6 changes: 3 additions & 3 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 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 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 HCP Terraform 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 @@ -121,7 +121,7 @@ var ErrInvalidExampleID = errors.New("invalid value for example ID") // move thi
var _ ExampleResource = (*example)(nil)

// Example represents all the example methods in the context of an organization
// that the Terraform Cloud/Enterprise API supports.
// that the HCP Terraform and Terraform Enterprise API supports.
// If this API is in beta or pre-release state, include that warning here.
type ExampleResource interface {
// Create an example for an organization
Expand All @@ -148,7 +148,7 @@ type example struct {
client *Client
}

// Example represents a TFC/E example resource
// Example represents a HCP Terraform and Terraform Enterprise example resource
type Example struct {
ID string `jsonapi:"primary,examples"`
Name string `jsonapi:"attr,name"`
Expand Down
2 changes: 1 addition & 1 deletion docs/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Start by comparing the main branch with the last release in order to fully under

1. Is the change added to CHANGELOG.md?
2. Does the public package API follow all endpoint conventions, such as naming, pointer usage, and options availability? Once these are released, they are permanent in the current major release version.
3. Are new features generally available in the Terraform Cloud API? Or is there another considered reason to release them?
3. Are new features generally available in the HCP Terraform API? Or is there another considered reason to release them?

Steps to prepare the changelog for a new release:

Expand Down