Skip to content

Commit

Permalink
Rename TFC to HCP Terraform (#1741)
Browse files Browse the repository at this point in the history
This renames all user facing information containing the words "Terraform Cloud" to "HCP Terraform".

It does not rename/refactor any code using the old references. The authentication provider ID and sesison key remain the same to preserve existing logins.

Co-authored-by: Ansgar Mertens <[email protected]>
  • Loading branch information
jpogran and ansgarm authored Apr 19, 2024
1 parent 58ed7b4 commit ef6e63c
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ If you have questions about Terraform VS Code extension usage, please feel free

## Enterprise/Commercial Support

If you are an existing Terraform Cloud or Enterprise customer on a [plan](https://www.hashicorp.com/products/terraform/pricing) with support included, please submit a HashiCorp support request or email [email protected]
If you are an existing HCP Terraform or Terraform Enterprise customer on a [plan](https://www.hashicorp.com/products/terraform/pricing) with support included, please submit a HashiCorp support request or email [email protected]
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Read the [Troubleshooting Guide](#troubleshooting) for answers to common questio
- [Code Navigation](#code-navigation) Navigate through your codebase with Go to Definition and Symbol support
- [Code Formatting](#code-formatting) Format your code with `terraform fmt` automatically
- [Code Snippets](#code-snippets) Shortcuts for common snippets like `for_each` and `variable`
- [Terraform Cloud Integration](#terraform-cloud-integration) View Terraform Cloud Workspaces and Run details inside VS Code
- [HCP Terraform Integration](#hcp-terraform-integration) View HCP Terraform Workspaces and Run details inside VS Code
- [Terraform Module Explorer](#terraform-module-and-provider-explorer) View all modules and providers referenced in the currently open document.
- [Terraform commands](#terraform-commands) Directly execute commands like `terraform init` or `terraform plan` from the VS Code Command Palette.

Expand Down Expand Up @@ -115,13 +115,13 @@ The extension provides several snippets to accelerate adding Terraform code to y
- `vare` - Empty variable
- `varm` - Map Variable

### Terraform Cloud Integration
### HCP Terraform Integration

Every time you have to switch away from your code, you risk losing momentum and the context about your tasks. Previously, Terraform users needed to have at least two windows open – their editor and a web page – to develop Terraform code. The editor contains all of the Terraform code they are working on, and the web page has the Terraform Cloud workspace loaded. Switching back and forth between the Terraform Cloud website and the text editor can be a frustrating and fragmented experience.
Every time you have to switch away from your code, you risk losing momentum and the context about your tasks. Previously, Terraform users needed to have at least two windows open – their editor and a web page – to develop Terraform code. The editor contains all of the Terraform code they are working on, and the web page has the HCP Terraform workspace loaded. Switching back and forth between the HCP Terraform website and the text editor can be a frustrating and fragmented experience.

The Terraform Cloud Visual Studio Code integration improves user experience by allowing users to view workspaces directly from within Visual Studio Code. Users can view the status of current and past runs and inspect detailed logs – without ever leaving the comfort of their editor.
The HCP Terraform Visual Studio Code integration improves user experience by allowing users to view workspaces directly from within Visual Studio Code. Users can view the status of current and past runs and inspect detailed logs – without ever leaving the comfort of their editor.

To start using Terraform Cloud with VS Code, open the new Terraform Cloud sidebar and click "Login to Terraform Cloud". You can login using a stored token from the Terraform CLI, an existing token you provide, or open the Terraform Cloud website to generate a new token.
To start using HCP Terraform with VS Code, open the new HCP Terraform sidebar and click "Login to HCP Terraform". You can login using a stored token from the Terraform CLI, an existing token you provide, or open the HCP Terraform website to generate a new token.

![](docs/tfc/login_view.gif)

Expand All @@ -141,7 +141,7 @@ If a Run has been Planned or Applied, you can view the raw log for each by expan

![](docs/tfc/plan_apply_view.gif)

To sign out or log out of your Terraform Cloud session, click the Accounts icon next to the Settings icon in the Activity Bar and select "Sign Out":
To sign out or log out of your HCP Terraform session, click the Accounts icon next to the Settings icon in the Activity Bar and select "Sign Out":

![](docs/tfc/log_out.png)

Expand Down
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@
},
{
"command": "terraform.cloud.login",
"title": "HashiCorp Terraform Cloud: Login",
"title": "HCP Terraform: Login",
"enablement": "terraform.cloud.signed-in === false"
},
{
Expand Down Expand Up @@ -516,7 +516,7 @@
},
{
"command": "terraform.cloud.organization.picker",
"title": "HashiCorp Terraform Cloud: Pick Organization",
"title": "HCP Terraform: Pick Organization",
"icon": "$(account)",
"enablement": "terraform.cloud.signed-in"
},
Expand Down Expand Up @@ -707,12 +707,12 @@
{
"id": "terraform.cloud.workspaces",
"name": "Workspaces",
"contextualTitle": "Terraform Cloud workspaces"
"contextualTitle": "HCP Terraform workspaces"
},
{
"id": "terraform.cloud.runs",
"name": "Runs",
"contextualTitle": "Terraform Cloud runs"
"contextualTitle": "HCP Terraform runs"
}
],
"terraform-cloud-panel": [
Expand All @@ -737,14 +737,14 @@
},
{
"id": "terraform-cloud",
"title": "HashiCorp Terraform Cloud",
"title": "HCP Terraform",
"icon": "assets/icons/vs_code_terraform_cloud.svg"
}
],
"panel": [
{
"id": "terraform-cloud-panel",
"title": "Terraform Cloud",
"title": "HCP Terraform",
"icon": "assets/icons/vs_code_terraform_cloud.svg"
}
]
Expand Down Expand Up @@ -802,12 +802,12 @@
},
{
"view": "terraform.cloud.workspaces",
"contents": "In order to use Terraform Cloud features, you need to be logged in\n[Login to Terraform Cloud](command:terraform.cloud.login)",
"contents": "In order to use HCP Terraform features, you need to be logged in\n[Login to HCP Terraform](command:terraform.cloud.login)",
"when": "terraform.cloud.signed-in === false"
},
{
"view": "terraform.cloud.workspaces",
"contents": "No organizations found for this token. Please create a new Terraform Cloud organization to get started\n[Create or select an organization](command:terraform.cloud.organization.picker)",
"contents": "No organizations found for this token. Please create a new HCP Terraform organization to get started\n[Create or select an organization](command:terraform.cloud.organization.picker)",
"when": "terraform.cloud.signed-in && !terraform.cloud.organizationsExist && !terraform.cloud.organizationsChosen"
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const documentSelector: DocumentSelector = [
{ scheme: 'file', language: 'terraform-vars' },
];
const outputChannel = vscode.window.createOutputChannel(brand);
const tfcOutputChannel = vscode.window.createOutputChannel('HashiCorp Terraform Cloud');
const tfcOutputChannel = vscode.window.createOutputChannel('HCP Terraform');

let reporter: TelemetryReporter;
let client: LanguageClient;
Expand Down
2 changes: 1 addition & 1 deletion src/features/terraformCloud.ts
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ export class OrganizationStatusBar implements vscode.Disposable {
this.organizationStatusBar.name = 'TFCOrganizationBar';
this.organizationStatusBar.command = {
command: 'terraform.cloud.organization.picker',
title: 'Choose your Terraform Cloud Organization',
title: 'Choose your HCP Terraform Organization',
};
}

Expand Down
18 changes: 10 additions & 8 deletions src/providers/authenticationProvider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ class TerraformCloudSessionHandler {
}
}
export class TerraformCloudAuthenticationProvider implements vscode.AuthenticationProvider, vscode.Disposable {
static providerLabel = 'HashiCorp Terraform Cloud';
static providerLabel = 'HashiCorp Cloud Platform Terraform';
// These are IDs and session keys that are used to identify the provider and the session in VS Code secret storage
// we cannot change these in the rebrand without the user losing the previous session
static providerID = 'HashiCorpTerraformCloud';
private sessionKey = 'HashiCorpTerraformCloudSession';
private logger: vscode.LogOutputChannel;
Expand Down Expand Up @@ -147,7 +149,7 @@ export class TerraformCloudAuthenticationProvider implements vscode.Authenticati
try {
const session = await this.sessionPromise;
if (session) {
this.logger.info('Successfully fetched Terraform Cloud session');
this.logger.info('Successfully fetched HCP Terraform session');
await vscode.commands.executeCommand('setContext', 'terraform.cloud.signed-in', true);
return [session];
} else {
Expand Down Expand Up @@ -178,7 +180,7 @@ export class TerraformCloudAuthenticationProvider implements vscode.Authenticati
try {
const session = await this.sessionHandler.store(token);
this.reporter.sendTelemetryEvent('tfc-login-success');
this.logger.info('Successfully logged in to Terraform Cloud');
this.logger.info('Successfully logged in to HCP Terraform');

await vscode.commands.executeCommand('setContext', 'terraform.cloud.signed-in', true);

Expand Down Expand Up @@ -263,14 +265,14 @@ export class TerraformCloudAuthenticationProvider implements vscode.Authenticati
},
{
label: 'Generate a user token',
detail: 'Open the Terraform Cloud website to generate a new token',
detail: 'Open the HCP Terraform website to generate a new token',
},
],
{
canPickMany: false,
ignoreFocusOut: true,
placeHolder: 'Choose a method to enter a Terraform Cloud user token',
title: 'HashiCorp Terraform Cloud Authentication',
placeHolder: 'Choose a method to enter a HCP Terraform user token',
title: 'HCP Terraform Authentication',
},
);
if (choice === undefined) {
Expand All @@ -287,7 +289,7 @@ export class TerraformCloudAuthenticationProvider implements vscode.Authenticati
token = await vscode.window.showInputBox({
ignoreFocusOut: true,
placeHolder: 'User access token',
prompt: 'Enter a Terraform Cloud user access token',
prompt: 'Enter a HCP Terraform user access token',
password: true,
});
break;
Expand All @@ -297,7 +299,7 @@ export class TerraformCloudAuthenticationProvider implements vscode.Authenticati
token = await vscode.window.showInputBox({
ignoreFocusOut: true,
placeHolder: 'User access token',
prompt: 'Enter a Terraform Cloud user access token',
prompt: 'Enter a HCP Terraform user access token',
password: true,
});
break;
Expand Down
2 changes: 1 addition & 1 deletion src/providers/tfc/organizationPicker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class OrganizationItem implements vscode.QuickPickItem {

export class OrganizationAPIResource implements APIResource {
name = 'organizations';
title = 'Welcome to Terraform Cloud';
title = 'Welcome to HCP Terraform';
placeholder = 'Choose an organization (type to search)';
ignoreFocusOut = true;

Expand Down
2 changes: 1 addition & 1 deletion test/specs/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ describe('VS Code Extension Testing', () => {
'Run and Debug',
'Extensions',
'HashiCorp Terraform',
'HashiCorp Terraform Cloud',
'HCP Terraform',
]);
});

Expand Down

0 comments on commit ef6e63c

Please sign in to comment.