Merge branch 'main' into mes/module-validation

2025-05-02 15:19:43 +00:00 · 2025-05-02 15:19:43 +00:00 · cc51af1b6e
commit cc51af1b6e
parent d4d307451f 9e18a4e3a8
10 changed files with 463 additions and 147 deletions
--- a/.env.example
+++ b/.env.example
@ -0,0 +1,23 @@
+# ---
+# These are used for the site health script, run from GitHub Actions. They can
+# be set manually if you need to run the script locally.
+
+# Coder admins for Instatus can get this value from https://dashboard.instatus.com/developer
+export INSTATUS_API_KEY=
+
+# Can be obtained from calling the Instatus API with a valid token. This value
+# might not actually need to be private, but better safe than sorry
+# https://instatus.com/help/api/status-pages
+export INSTATUS_PAGE_ID=
+
+# Can be obtained from calling the Instatus API with a valid token. This value
+# might not actually need to be private, but better safe than sorry
+# https://instatus.com/help/api/components
+export INSTATUS_COMPONENT_ID=
+
+# Can be grabbed from https://vercel.com/codercom/registry/stores/integration/upstash/store_1YDPuBF4Jd0aNpuV/guides
+# Please make sure that the token you use is KV_REST_API_TOKEN; the script needs
+# to be able to queries and mutations
+export VERCEL_API_KEY=
+
+# ---
--- a/.github/scripts/check_registry_site_health.sh
+++ b/.github/scripts/check_registry_site_health.sh
@ -4,23 +4,23 @@ set -u

 VERBOSE="${VERBOSE:-0}"
 if [[ "${VERBOSE}" -ne "0" ]]; then
-    set -x
+  set -x
 fi

 # List of required environment variables
 required_vars=(
-    "INSTATUS_API_KEY"
-    "INSTATUS_PAGE_ID"
-    "INSTATUS_COMPONENT_ID"
-    "VERCEL_API_KEY"
+  "INSTATUS_API_KEY"
+  "INSTATUS_PAGE_ID"
+  "INSTATUS_COMPONENT_ID"
+  "VERCEL_API_KEY"
 )

 # Check if each required variable is set
 for var in "${required_vars[@]}"; do
-    if [[ -z "${!var:-}" ]]; then
-        echo "Error: Environment variable '$var' is not set."
-        exit 1
-    fi
+  if [[ -z "${!var:-}" ]]; then
+    echo "Error: Environment variable '$var' is not set."
+    exit 1
+  fi
 done

 REGISTRY_BASE_URL="${REGISTRY_BASE_URL:-https://registry.coder.com}"
@ -31,38 +31,38 @@ declare -a failures=()

 # Collect all module directories containing a main.tf file
 for path in $(find . -maxdepth 2 -not -path '*/.*' -type f -name main.tf | cut -d '/' -f 2 | sort -u); do
-    modules+=("${path}")
+  modules+=("${path}")
 done

 echo "Checking modules: ${modules[*]}"

 # Function to update the component status on Instatus
 update_component_status() {
-    local component_status=$1
-    # see https://instatus.com/help/api/components
-    (curl -X PUT "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/components/$INSTATUS_COMPONENT_ID" \
-        -H "Authorization: Bearer $INSTATUS_API_KEY" \
-        -H "Content-Type: application/json" \
-        -d "{\"status\": \"$component_status\"}")
+  local component_status=$1
+  # see https://instatus.com/help/api/components
+  (curl -X PUT "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/components/$INSTATUS_COMPONENT_ID" \
+    -H "Authorization: Bearer $INSTATUS_API_KEY" \
+    -H "Content-Type: application/json" \
+    -d "{\"status\": \"$component_status\"}")
 }

 # Function to create an incident
 create_incident() {
-    local incident_name="Degraded Service"
-    local message="The following modules are experiencing issues:\n"
-    for i in "${!failures[@]}"; do
-        message+="$((i + 1)). ${failures[$i]}\n"
-    done
+  local incident_name="Degraded Service"
+  local message="The following modules are experiencing issues:\n"
+  for i in "${!failures[@]}"; do
+    message+="$((i + 1)). ${failures[$i]}\n"
+  done

-    component_status="PARTIALOUTAGE"
-    if ((${#failures[@]} == ${#modules[@]})); then
-        component_status="MAJOROUTAGE"
-    fi
-    # see https://instatus.com/help/api/incidents
-    incident_id=$(curl -s -X POST "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/incidents" \
-        -H "Authorization: Bearer $INSTATUS_API_KEY" \
-        -H "Content-Type: application/json" \
-        -d "{
+  component_status="PARTIALOUTAGE"
+  if ((${#failures[@]} == ${#modules[@]})); then
+    component_status="MAJOROUTAGE"
+  fi
+  # see https://instatus.com/help/api/incidents
+  incident_id=$(curl -s -X POST "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/incidents" \
+    -H "Authorization: Bearer $INSTATUS_API_KEY" \
+    -H "Content-Type: application/json" \
+    -d "{
            \"name\": \"$incident_name\",
            \"message\": \"$message\",
            \"components\": [\"$INSTATUS_COMPONENT_ID\"],
@ -76,129 +76,129 @@ create_incident() {
            ]
        }" | jq -r '.id')

-    echo "Created incident with ID: $incident_id"
+  echo "Created incident with ID: $incident_id"
 }

 # Function to check for existing unresolved incidents
 check_existing_incident() {
-    # Fetch the latest incidents with status not equal to "RESOLVED"
-    local unresolved_incidents=$(curl -s -X GET "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/incidents" \
-        -H "Authorization: Bearer $INSTATUS_API_KEY" \
-        -H "Content-Type: application/json" | jq -r '.incidents[] | select(.status != "RESOLVED") | .id')
+  # Fetch the latest incidents with status not equal to "RESOLVED"
+  local unresolved_incidents=$(curl -s -X GET "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/incidents" \
+    -H "Authorization: Bearer $INSTATUS_API_KEY" \
+    -H "Content-Type: application/json" | jq -r '.incidents[] | select(.status != "RESOLVED") | .id')

-    if [[ -n "$unresolved_incidents" ]]; then
-        echo "Unresolved incidents found: $unresolved_incidents"
-        return 0 # Indicate that there are unresolved incidents
-    else
-        echo "No unresolved incidents found."
-        return 1 # Indicate that no unresolved incidents exist
-    fi
+  if [[ -n "$unresolved_incidents" ]]; then
+    echo "Unresolved incidents found: $unresolved_incidents"
+    return 0 # Indicate that there are unresolved incidents
+  else
+    echo "No unresolved incidents found."
+    return 1 # Indicate that no unresolved incidents exist
+  fi
 }

 force_redeploy_registry() {
-    # These are not secret values; safe to just expose directly in script
-    local VERCEL_TEAM_SLUG="codercom"
-    local VERCEL_TEAM_ID="team_tGkWfhEGGelkkqUUm9nXq17r"
-    local VERCEL_APP="registry"
+  # These are not secret values; safe to just expose directly in script
+  local VERCEL_TEAM_SLUG="codercom"
+  local VERCEL_TEAM_ID="team_tGkWfhEGGelkkqUUm9nXq17r"
+  local VERCEL_APP="registry"

-    local latest_res
-    latest_res=$(
-        curl "https://api.vercel.com/v6/deployments?app=$VERCEL_APP&limit=1&slug=$VERCEL_TEAM_SLUG&teamId=$VERCEL_TEAM_ID&target=production&state=BUILDING,INITIALIZING,QUEUED,READY" \
-            --fail \
-            --silent \
-            --header "Authorization: Bearer $VERCEL_API_KEY" \
-            --header "Content-Type: application/json"
-    )
+  local latest_res
+  latest_res=$(
+    curl "https://api.vercel.com/v6/deployments?app=$VERCEL_APP&limit=1&slug=$VERCEL_TEAM_SLUG&teamId=$VERCEL_TEAM_ID&target=production&state=BUILDING,INITIALIZING,QUEUED,READY" \
+      --fail \
+      --silent \
+      --header "Authorization: Bearer $VERCEL_API_KEY" \
+      --header "Content-Type: application/json"
+  )

-    # If we have zero deployments, something is VERY wrong. Make the whole
-    # script exit with a non-zero status code
-    local latest_id
-    latest_id=$(echo "${latest_res}" | jq -r '.deployments[0].uid')
-    if [[ "${latest_id}" = "null" ]]; then
-        echo "Unable to pull any previous deployments for redeployment"
-        echo "Please redeploy the latest deployment manually in Vercel."
-        echo "https://vercel.com/codercom/registry/deployments"
-        exit 1
-    fi
+  # If we have zero deployments, something is VERY wrong. Make the whole
+  # script exit with a non-zero status code
+  local latest_id
+  latest_id=$(echo "${latest_res}" | jq -r '.deployments[0].uid')
+  if [[ "${latest_id}" = "null" ]]; then
+    echo "Unable to pull any previous deployments for redeployment"
+    echo "Please redeploy the latest deployment manually in Vercel."
+    echo "https://vercel.com/codercom/registry/deployments"
+    exit 1
+  fi

-    local latest_date_ts_seconds
-    latest_date_ts_seconds=$(echo "${latest_res}" | jq -r '.deployments[0].createdAt/1000|floor')
-    local current_date_ts_seconds
-    current_date_ts_seconds="$(date +%s)"
-    local max_redeploy_interval_seconds=7200 # 2 hours
-    if ((current_date_ts_seconds - latest_date_ts_seconds < max_redeploy_interval_seconds)); then
-        echo "The registry was deployed less than 2 hours ago."
-        echo "Not automatically re-deploying the regitstry."
-        echo "A human reading this message should decide if a redeployment is necessary."
-        echo "Please check the Vercel dashboard for more information."
-        echo "https://vercel.com/codercom/registry/deployments"
-        exit 1
-    fi
+  local latest_date_ts_seconds
+  latest_date_ts_seconds=$(echo "${latest_res}" | jq -r '.deployments[0].createdAt/1000|floor')
+  local current_date_ts_seconds
+  current_date_ts_seconds="$(date +%s)"
+  local max_redeploy_interval_seconds=7200 # 2 hours
+  if ((current_date_ts_seconds - latest_date_ts_seconds < max_redeploy_interval_seconds)); then
+    echo "The registry was deployed less than 2 hours ago."
+    echo "Not automatically re-deploying the regitstry."
+    echo "A human reading this message should decide if a redeployment is necessary."
+    echo "Please check the Vercel dashboard for more information."
+    echo "https://vercel.com/codercom/registry/deployments"
+    exit 1
+  fi

-    local latest_deployment_state
-    latest_deployment_state="$(echo "${latest_res}" | jq -r '.deployments[0].state')"
-    if [[ "${latest_deployment_state}" != "READY" ]]; then
-        echo "Last deployment was not in READY state. Skipping redeployment."
-        echo "A human reading this message should decide if a redeployment is necessary."
-        echo "Please check the Vercel dashboard for more information."
-        echo "https://vercel.com/codercom/registry/deployments"
-        exit 1
-    fi
+  local latest_deployment_state
+  latest_deployment_state="$(echo "${latest_res}" | jq -r '.deployments[0].state')"
+  if [[ "${latest_deployment_state}" != "READY" ]]; then
+    echo "Last deployment was not in READY state. Skipping redeployment."
+    echo "A human reading this message should decide if a redeployment is necessary."
+    echo "Please check the Vercel dashboard for more information."
+    echo "https://vercel.com/codercom/registry/deployments"
+    exit 1
+  fi

-    echo "============================================================="
-    echo "!!! Redeploying registry with deployment ID: ${latest_id} !!!"
-    echo "============================================================="
+  echo "============================================================="
+  echo "!!! Redeploying registry with deployment ID: ${latest_id} !!!"
+  echo "============================================================="

-    if ! curl -X POST "https://api.vercel.com/v13/deployments?forceNew=1&skipAutoDetectionConfirmation=1&slug=$VERCEL_TEAM_SLUG&teamId=$VERCEL_TEAM_ID" \
-        --fail \
-        --header "Authorization: Bearer $VERCEL_API_KEY" \
-        --header "Content-Type: application/json" \
-        --data-raw "{ \"deploymentId\": \"${latest_id}\", \"name\": \"${VERCEL_APP}\", \"target\": \"production\" }"; then
-        echo "DEPLOYMENT FAILED! Please check the Vercel dashboard for more information."
-        echo "https://vercel.com/codercom/registry/deployments"
-        exit 1
-    fi
+  if ! curl -X POST "https://api.vercel.com/v13/deployments?forceNew=1&skipAutoDetectionConfirmation=1&slug=$VERCEL_TEAM_SLUG&teamId=$VERCEL_TEAM_ID" \
+    --fail \
+    --header "Authorization: Bearer $VERCEL_API_KEY" \
+    --header "Content-Type: application/json" \
+    --data-raw "{ \"deploymentId\": \"${latest_id}\", \"name\": \"${VERCEL_APP}\", \"target\": \"production\" }"; then
+    echo "DEPLOYMENT FAILED! Please check the Vercel dashboard for more information."
+    echo "https://vercel.com/codercom/registry/deployments"
+    exit 1
+  fi
 }

 # Check each module's accessibility
 for module in "${modules[@]}"; do
-    # Trim leading/trailing whitespace from module name
-    module=$(echo "${module}" | xargs)
-    url="${REGISTRY_BASE_URL}/modules/${module}"
-    printf "=== Checking module %s at %s\n" "${module}" "${url}"
-    status_code=$(curl --output /dev/null --head --silent --fail --location "${url}" --retry 3 --write-out "%{http_code}")
-    if ((status_code != 200)); then
-        printf "==> FAIL(%s)\n" "${status_code}"
-        status=1
-        failures+=("${module}")
-    else
-        printf "==> OK(%s)\n" "${status_code}"
-    fi
+  # Trim leading/trailing whitespace from module name
+  module=$(echo "${module}" | xargs)
+  url="${REGISTRY_BASE_URL}/modules/${module}"
+  printf "=== Checking module %s at %s\n" "${module}" "${url}"
+  status_code=$(curl --output /dev/null --head --silent --fail --location "${url}" --retry 3 --write-out "%{http_code}")
+  if ((status_code != 200)); then
+    printf "==> FAIL(%s)\n" "${status_code}"
+    status=1
+    failures+=("${module}")
+  else
+    printf "==> OK(%s)\n" "${status_code}"
+  fi
 done

 # Determine overall status and update Instatus component
 if ((status == 0)); then
-    echo "All modules are operational."
-    # set to
-    update_component_status "OPERATIONAL"
+  echo "All modules are operational."
+  # set to
+  update_component_status "OPERATIONAL"
 else
-    echo "The following modules have issues: ${failures[*]}"
-    # check if all modules are down
-    if ((${#failures[@]} == ${#modules[@]})); then
-        update_component_status "MAJOROUTAGE"
-    else
-        update_component_status "PARTIALOUTAGE"
-    fi
+  echo "The following modules have issues: ${failures[*]}"
+  # check if all modules are down
+  if ((${#failures[@]} == ${#modules[@]})); then
+    update_component_status "MAJOROUTAGE"
+  else
+    update_component_status "PARTIALOUTAGE"
+  fi

-    # Check if there is an existing incident before creating a new one
-    if ! check_existing_incident; then
-        create_incident
-    fi
+  # Check if there is an existing incident before creating a new one
+  if ! check_existing_incident; then
+    create_incident
+  fi

-    # If a module is down, force a reployment to try getting things back online
-    # ASAP
-    # EDIT: registry.coder.com is no longer hosted on vercel
-    #force_redeploy_registry
+  # If a module is down, force a reployment to try getting things back online
+  # ASAP
+  # EDIT: registry.coder.com is no longer hosted on vercel
+  #force_redeploy_registry
 fi

 exit "${status}"
--- a/.github/typos.toml
+++ b/.github/typos.toml
@ -0,0 +1,4 @@
+[default.extend-words]
+muc = "muc" # For Munich location code
+Hashi = "Hashi"
+HashiCorp = "HashiCorp"
--- a/.github/workflows/check_registry_site_health.yaml
+++ b/.github/workflows/check_registry_site_health.yaml
@ -0,0 +1,23 @@
+# Check modules health on registry.coder.com
+name: check-registry-site-health
+on:
+  schedule:
+    - cron: "0,15,30,45 * * * *" # Runs every 15 minutes
+  workflow_dispatch: # Allows manual triggering of the workflow if needed
+
+jobs:
+  run-script:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run check.sh
+        run: |
+          ./.github/scripts/check_registry_site_health.sh
+        env:
+          INSTATUS_API_KEY: ${{ secrets.INSTATUS_API_KEY }}
+          INSTATUS_PAGE_ID: ${{ secrets.INSTATUS_PAGE_ID }}
+          INSTATUS_COMPONENT_ID: ${{ secrets.INSTATUS_COMPONENT_ID }}
+          VERCEL_API_KEY: ${{ secrets.VERCEL_API_KEY }}
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@ -7,20 +7,8 @@ concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 jobs:
-  validate-readme-files:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v4
-      - name: Set up Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: "1.23.2"
-      - name: Validate contributors
-        run: go build ./cmd/readmevalidation && ./readmevalidation
-      - name: Remove build file artifact
-        run: rm ./readmevalidation
  test-terraform:
+    name: Validate Terraform output
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
@ -38,5 +26,45 @@ jobs:
          bun-version: latest
      - name: Install dependencies
        run: bun install
-      - name: Run tests
+      - name: Run TypeScript tests
        run: bun test
+      - name: Run Terraform Validate
+        run: bun terraform-validate
+  validate-style:
+    name: Check for typos and unformatted code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Install Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      # Need Terraform for its formatter
+      - name: Install Terraform
+        uses: coder/coder/.github/actions/setup-tf@main
+      - name: Install dependencies
+        run: bun install
+      - name: Validate formatting
+        run: bun fmt:ci
+      - name: Check for typos
+        uses: crate-ci/typos@v1.31.1
+        with:
+          config: .github/typos.toml
+  validate-readme-files:
+    name: Validate README files
+    runs-on: ubuntu-latest
+    # We want to do some basic README checks first before we try analyzing the
+    # contents
+    needs: validate-style
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.23.2"
+      - name: Validate contributors
+        run: go build ./cmd/readmevalidation && ./readmevalidation
+      - name: Remove build file artifact
+        run: rm ./readmevalidation
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,200 @@
+# Contributing
+
+## Getting started
+
+This repo uses two main runtimes to verify the correctness of a module/template before it is published:
+
+- [Bun](https://bun.sh/) – Used to run tests for each module/template to validate overall functionality and correctness of Terraform output
+- [Go](https://go.dev/) – Used to validate all README files in the directory
+
+### Installing Bun
+
+To install Bun, you can run this command on Linux/MacOS:
+
+```shell
+curl -fsSL https://bun.sh/install | bash
+```
+
+Or this command on Windows:
+
+```shell
+powershell -c "irm bun.sh/install.ps1 | iex"
+```
+
+Follow the instructions to ensure that Bun is available globally. Once Bun is installed, install all necessary dependencies from the root of the repo:
+
+Via NPM:
+
+```shell
+npm i
+```
+
+Via PNPM:
+
+```shell
+pnpm i
+```
+
+This repo does not support Yarn.
+
+### Installing Go (optional)
+
+This step can be skipped if you are not working on any of the README validation logic. The validation will still run as part of CI.
+
+[Navigate to the official Go Installation page](https://go.dev/doc/install), and install the correct version for your operating system.
+
+Once Go has been installed, verify the installation via:
+
+```shell
+go version
+```
+
+### Adding a new module/template (coming soon)
+
+Once Bun (and possibly Go) have been installed, clone this repository. From there, you can run this script to make it easier to start contributing a new module or template:
+
+```shell
+./new.sh NAME_OF_NEW_MODULE
+```
+
+You can also create the correct module/template files manually.
+
+## Testing a Module
+
+> [!IMPORTANT]
+> It is the responsibility of the module author to implement tests for every new module they wish to contribute. It falls to the author to test the module locally before submitting a PR.
+
+All general-purpose test helpers for validating Terraform can be found in the top-level `/testing` directory. The helpers run `terraform apply` on modules that use variables, testing the script output against containers.
+
+> [!NOTE]
+> The testing suite must be able to run docker containers with the `--network=host` flag. This typically requires running the tests on Linux as this flag does not apply to Docker Desktop for MacOS and Windows. MacOS users can work around this by using something like [colima](https://github.com/abiosoft/colima) or [Orbstack](https://orbstack.dev/) instead of Docker Desktop.
+
+You can reference the existing `*.test.ts` files to get an idea for how to set up tests.
+
+You can run all tests by running this command:
+
+```shell
+bun test
+```
+
+Note that tests can take some time to run, so you probably don't want to be running this as part of your development loop.
+
+To run specific tests, you can use the `-t` flag, which accepts a filepath regex:
+
+```shell
+bun test -t '<regex_pattern>'
+```
+
+To ensure that the module runs predictably in local development, you can update the Terraform source as follows:
+
+```tf
+module "example" {
+  # You may need to remove the 'version' field, it is incompatible with some sources.
+  source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
+}
+```
+
+## Adding/modifying README files
+
+This repo uses Go to do a quick validation of each README. If you are working with the README files at all, it is strongly recommended that you install Go, so that the files can be validated locally.
+
+### Validating all README files
+
+To validate all README files throughout the entire repo, you can run the following:
+
+```shell
+go build ./cmd/readmevalidation && ./readmevalidation
+```
+
+The resulting binary is already part of the `.gitignore` file, but you can quickly remove it with:
+
+```shell
+rm ./readmevalidation
+```
+
+### README validation criteria
+
+The following criteria exists for one of two reasons: (1) content accessibility, or (2) having content be designed in a way that's easy for the Registry site build step to use:
+
+#### General README requirements
+
+- There must be a frontmatter section.
+- There must be exactly one h1 header, and it must be at the very top
+- The README body (if it exists) must start with an h1 header. No other content (including GitHub-Flavored Markdown alerts) is allowed to be placed above it.
+- When increasing the level of a header, the header's level must be incremented by one each time.
+- Additional image/video assets can be placed in one of two places:
+  - In the same user namespace directory where that user's main content lives
+  - In the top-level `.icons` directory
+- Any `.hcl` code snippets must be labeled as `.tf` snippets instead
+
+  ```txt
+  \`\`\`tf
+  Content
+  \`\`\`
+  ```
+
+#### Contributor profiles
+
+- The README body is allowed to be empty, but if it isn't, it must follow all the rules above.
+- The frontmatter supports the following fields:
+  - `display_name` (required string) – The name to use when displaying your user profile in the Coder Registry site
+  - `bio` (optional string) – A short description of who you are
+  - `github` (required string) – Your GitHub handle
+  - `avatar_url` (optional string) – A relative/absolute URL pointing to your avatar
+  - `linkedin` (optional string) – A URL pointing to your LinkedIn page
+  - `support_email` (optional string) – An email for users to reach you at if they need help with a published module/template
+  - `employer_github` (optional string) – The name of another user namespace whom you'd like to have associated with your account. The namespace must also exist in the repo, or else the README validation will fail.
+  - `status` (optional string union) – If defined, must be one of "community", "partner", or "official". "Community" is treated as the default value if not specified, and should be used for the majority of external contributions. "Official" should be used for Coder and Coder satellite companies. "Partner" is for companies who have a formal business agreement with Coder.
+
+#### Modules and templates
+
+- The frontmatter supports the following fields:
+  - `description` (required string) A short description of what the module/template does.
+  - `icon` (required string) – A URL pointing to the icon to use for the module/template when viewing it on the Registry website.
+  - `display_name` (optional string) – A name to display instead of the name intuited from the module's/template's directory name
+  - `verified` (optional boolean) – A boolean indicated that the Coder team has officially tested and vouched for the functionality/reliability of a given module or template. This field should only be changed by Coder employees.
+  - `tags` (optional string array) – A list of tags to associate with the module/template. Users will be able to search for these tags from the Registry website.
+
+## Releases
+
+The release process is automated with these steps:
+
+### 1. Create and merge a new PR
+
+- Create a PR with your module changes
+- Get your PR reviewed, approved, and merged into the `main` branch
+
+### 2. Prepare Release (Maintainer Task)
+
+After merging to `main`, a maintainer will:
+
+- View all modules and their current versions:
+
+  ```shell
+  ./release.sh --list
+  ```
+
+- Determine the next version number based on changes:
+
+  - **Patch version** (1.2.3 → 1.2.4): Bug fixes
+  - **Minor version** (1.2.3 → 1.3.0): New features, adding inputs, deprecating inputs
+  - **Major version** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing input types)
+
+- Create and push an annotated tag:
+
+  ```shell
+  # Fetch latest changes
+  git fetch origin
+  
+  # Create and push tag
+  ./release.sh module-name 1.2.3 --push
+  ```
+
+  The tag format will be: `release/module-name/v1.2.3`
+
+### 3. Publishing to Coder Registry
+
+Our automated processes will handle publishing new data to [registry.coder.com](https://registry.coder.com).
+
+> [!NOTE]
+> Some data in registry.coder.com is fetched on demand from the [coder/modules](https://github.com/coder/modules) repo's `main` branch. This data should update almost immediately after a release, while other changes will take some time to propagate.
--- a/README.md
+++ b/README.md
@ -1,3 +1,3 @@
-# hub
+# Coder Registry

 Publish Coder modules and templates for other developers to use.
--- a/examples/modules/run.sh
+++ b/examples/modules/run.sh
@ -11,10 +11,10 @@ BOLD='\033[0;1m'
 printf "$${BOLD}Installing MODULE_NAME ...\n\n"

 # Add code here
-# Use varibles from the templatefile function in main.tf
+# Use variables from the templatefile function in main.tf
 # e.g. LOG_PATH, PORT, etc.

-printf "🥳 Installation comlete!\n\n"
+printf "🥳 Installation complete!\n\n"

 printf "👷 Starting MODULE_NAME in background...\n\n"
 # Start the app in here
--- a/package.json
+++ b/package.json
@ -1,9 +1,10 @@
 {
  "name": "modules",
  "scripts": {
+    "fmt": "bun x prettier --write **/*.sh **/*.ts **/*.md *.md && terraform fmt -recursive -diff",
+    "fmt:ci": "bun x prettier --check **/*.sh **/*.ts **/*.md *.md && terraform fmt -check -recursive -diff",
+    "terraform-validate": "./scripts/terraform_validate.sh",
    "test": "bun test",
-    "fmt": "bun x prettier -w **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt **/*.tf .sample/main.tf",
-    "fmt:ci": "bun x prettier --check **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt -check **/*.tf .sample/main.tf",
    "update-version": "./update-version.sh"
  },
  "devDependencies": {
--- a/scripts/terraform_validate.sh
+++ b/scripts/terraform_validate.sh
@ -0,0 +1,37 @@
+#!/bin/bash
+
+set -euo pipefail
+
+validate_terraform_directory() {
+  local dir="$1"
+  echo "Running \`terraform validate\` in $dir"
+  pushd "$dir"
+  terraform init -upgrade
+  terraform validate
+  popd
+}
+
+main() {
+  # Get the directory of the script
+  local script_dir=$(dirname "$(readlink -f "$0")")
+
+  # Code assumes that registry directory will always be in same position
+  # relative to the main script directory
+  local registry_dir="$script_dir/../registry"
+
+  # Get all subdirectories in the registry directory. Code assumes that
+  # Terraform directories won't begin to appear until three levels deep into
+  # the registry (e.g., registry/coder/modules/coder-login, which will then
+  # have a main.tf file inside it)
+  local subdirs=$(find "$registry_dir" -mindepth 3 -type d | sort)
+
+  for dir in $subdirs; do
+    # Skip over any directories that obviously don't have the necessary
+    # files
+    if test -f "$dir/main.tf"; then
+      validate_terraform_directory "$dir"
+    fi
+  done
+}
+
+main