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

Use underscores in Terraform file names instead of dashes #152

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/send-system-notification.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
channel:
description: "Name of channel to use. Must be defined in /infra/project-config/system-notifications.tf"
description: "Name of channel to use. Must be defined in /infra/project-config/system_notifications.tf"
required: true
type: string
message:
Expand Down
6 changes: 6 additions & 0 deletions docs/infra/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [Terraform code style](#terraform-code-style)
- [Exceptions and additions to Hashicorp's Terraform style guide](#exceptions-and-additions-to-hashicorps-terraform-style-guide)
- [Modules](#modules)
- [File Names](#file-names)
- [Variables](#variables)
- [.gitignore](#gitignore)
- [Integration and unit testing](#integration-and-unit-testing)
Expand All @@ -28,6 +29,11 @@ Here are some exceptions (and additions) to Hashicorp's Terraform style guide.
- [Use shared configuration](/docs/infra/module-dependencies.md) instead of the [tfe_outputs data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) to share state between two state files.
- Use underscores instead of dashes in file names and module names.

#### File Names

- Separate words in filenames with underscores (\_) instead of dashes (-), e.g., main.tf, output_variables.tf.
- Use lowercase letters to avoid case sensitivity issues.

#### Variables

- Include additional type information in string variable names to clarify the value being stored. For example, use `access_policy_arn` instead of `access_policy`. Common examples of suffixes include: `_id`, `_arn`, and `_name`.
Expand Down
2 changes: 1 addition & 1 deletion docs/infra/system-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ The project sends notifications as part of CI/CD workflows to notify the team ab

## System notifications configuration

The configuration for system notifications is defined in the application's [project-config module](/infra/project-config/). The [system-notifications.tf](/infra/project-config/system-notifications.tf) file defines one or more notification channels that CI/CD workflows can send notifications to. Each channel can use a different notification type. Currently, Slack is the only supported notification type.
The configuration for system notifications is defined in the application's [project-config module](/infra/project-config/). The [system_notifications.tf](/infra/project-config/system_notifications.tf) file defines one or more notification channels that CI/CD workflows can send notifications to. Each channel can use a different notification type. Currently, Slack is the only supported notification type.
Loading