docs: replace example that requires TFC (#114)

ethanndickson · web-flow · commit 7bbfc7f2f7d8 · 2024-10-18T14:45:43.000+11:00
diff --git a/docs/resources/template.md b/docs/resources/template.md
@@ -22,8 +22,8 @@ When importing, the ID supplied can be either a template UUID retrieved via the
 // Provider populated from environment variables
 provider "coderd" {}
 
-// Get the commit SHA of the configuration's git repository
-variable "TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA" {
+// Can be populated using an environment variable, or an external datasource script
+variable "COMMIT_SHA" {
   type = string
 }
 
@@ -38,12 +38,12 @@ resource "coderd_template" "ubuntu-main" {
   description = "The main template for developing on Ubuntu."
   versions = [
     {
-      name        = "stable-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"
+      name        = "stable-${var.COMMIT_SHA}"
       description = "The stable version of the template."
       directory   = "./stable-template"
     },
     {
-      name        = "staging-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"
+      name        = "staging-${var.COMMIT_SHA}"
       description = "The staging version of the template."
       directory   = "./staging-template"
     }
diff --git a/examples/resources/coderd_template/resource.tf b/examples/resources/coderd_template/resource.tf
@@ -1,8 +1,8 @@
 // Provider populated from environment variables
 provider "coderd" {}
 
-// Get the commit SHA of the configuration's git repository
-variable "TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA" {
+// Can be populated using an environment variable, or an external datasource script
+variable "COMMIT_SHA" {
   type = string
 }
 
@@ -17,12 +17,12 @@ resource "coderd_template" "ubuntu-main" {
   description = "The main template for developing on Ubuntu."
   versions = [
     {
-      name        = "stable-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"
+      name        = "stable-${var.COMMIT_SHA}"
       description = "The stable version of the template."
       directory   = "./stable-template"
     },
     {
-      name        = "staging-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"
+      name        = "staging-${var.COMMIT_SHA}"
       description = "The staging version of the template."
       directory   = "./staging-template"
     }

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ When importing, the ID supplied can be either a template UUID retrieved via the`
`22`	`22`	`// Provider populated from environment variables`
`23`	`23`	`provider "coderd" {}`
`24`	`24`
`25`		`-// Get the commit SHA of the configuration's git repository`
`26`		`-variable "TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA" {`
	`25`	`+// Can be populated using an environment variable, or an external datasource script`
	`26`	`+variable "COMMIT_SHA" {`
`27`	`27`	`type = string`
`28`	`28`	`}`
`29`	`29`
`@@ -38,12 +38,12 @@ resource "coderd_template" "ubuntu-main" {`
`38`	`38`	`description = "The main template for developing on Ubuntu."`
`39`	`39`	`versions = [`
`40`	`40`	`{`
`41`		`- name = "stable-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"`
	`41`	`+ name = "stable-${var.COMMIT_SHA}"`
`42`	`42`	`description = "The stable version of the template."`
`43`	`43`	`directory = "./stable-template"`
`44`	`44`	`},`
`45`	`45`	`{`
`46`		`- name = "staging-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"`
	`46`	`+ name = "staging-${var.COMMIT_SHA}"`
`47`	`47`	`description = "The staging version of the template."`
`48`	`48`	`directory = "./staging-template"`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`// Provider populated from environment variables`
`2`	`2`	`provider "coderd" {}`
`3`	`3`
`4`		`-// Get the commit SHA of the configuration's git repository`
`5`		`-variable "TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA" {`
	`4`	`+// Can be populated using an environment variable, or an external datasource script`
	`5`	`+variable "COMMIT_SHA" {`
`6`	`6`	`type = string`
`7`	`7`	`}`
`8`	`8`
`@@ -17,12 +17,12 @@ resource "coderd_template" "ubuntu-main" {`
`17`	`17`	`description = "The main template for developing on Ubuntu."`
`18`	`18`	`versions = [`
`19`	`19`	`{`
`20`		`- name = "stable-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"`
	`20`	`+ name = "stable-${var.COMMIT_SHA}"`
`21`	`21`	`description = "The stable version of the template."`
`22`	`22`	`directory = "./stable-template"`
`23`	`23`	`},`
`24`	`24`	`{`
`25`		`- name = "staging-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"`
	`25`	`+ name = "staging-${var.COMMIT_SHA}"`
`26`	`26`	`description = "The staging version of the template."`
`27`	`27`	`directory = "./staging-template"`
`28`	`28`	`}`