Skip to content

Commit 153027e

Browse files
committed
fix: update all README files to match new submission standards
1 parent 4b7d152 commit 153027e

File tree

7 files changed

+20
-32
lines changed

7 files changed

+20
-32
lines changed

cmd/readmevalidation/coderresources.go

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -222,18 +222,15 @@ func validateCoderTemplateReadmeBody(body string) []error {
222222
errs = append(errs, baseErrs...)
223223
}
224224

225+
var nextLine string
225226
foundParagraph := false
226-
terraformCodeBlockCount := 0
227-
foundTerraformVersionRef := false
228-
229-
lineNum := 0
230227
isInsideCodeBlock := false
231-
isInsideTerraform := false
228+
lineNum := 0
232229

233230
lineScanner := bufio.NewScanner(strings.NewReader(trimmed))
234231
for lineScanner.Scan() {
235232
lineNum++
236-
nextLine := lineScanner.Text()
233+
nextLine = lineScanner.Text()
237234

238235
// Code assumes that invalid headers would've already been handled by the base validation function, so we don't
239236
// need to check deeper if the first line isn't an h1.
@@ -246,23 +243,12 @@ func validateCoderTemplateReadmeBody(body string) []error {
246243

247244
if strings.HasPrefix(nextLine, "```") {
248245
isInsideCodeBlock = !isInsideCodeBlock
249-
isInsideTerraform = isInsideCodeBlock && strings.HasPrefix(nextLine, "```tf")
250-
if isInsideTerraform {
251-
terraformCodeBlockCount++
252-
}
253246
if strings.HasPrefix(nextLine, "```hcl") {
254247
errs = append(errs, xerrors.New("all .hcl language references must be converted to .tf"))
255248
}
256249
continue
257250
}
258251

259-
if isInsideCodeBlock {
260-
if isInsideTerraform {
261-
foundTerraformVersionRef = foundTerraformVersionRef || terraformVersionRe.MatchString(nextLine)
262-
}
263-
continue
264-
}
265-
266252
// Code assumes that we can treat this case as the end of the "h1 section" and don't need to process any further lines.
267253
if lineNum > 1 && strings.HasPrefix(nextLine, "#") {
268254
break
@@ -275,16 +261,6 @@ func validateCoderTemplateReadmeBody(body string) []error {
275261
foundParagraph = foundParagraph || isParagraph
276262
}
277263

278-
if terraformCodeBlockCount == 0 {
279-
errs = append(errs, xerrors.New("did not find Terraform code block within h1 section"))
280-
} else {
281-
if terraformCodeBlockCount > 1 {
282-
errs = append(errs, xerrors.New("cannot have more than one Terraform code block in h1 section"))
283-
}
284-
if !foundTerraformVersionRef {
285-
errs = append(errs, xerrors.New("did not find Terraform code block that specifies 'version' field"))
286-
}
287-
}
288264
if !foundParagraph {
289265
errs = append(errs, xerrors.New("did not find paragraph within h1 section"))
290266
}

registry/coder/templates/gcp-devcontainer/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags: [vm, linux, gcp, devcontainer]
88

99
# Remote Development in a Devcontainer on Google Compute Engine
1010

11+
Provision a Devcontainer on Google Compute Engine instances as Coder workspaces
12+
1113
![Architecture Diagram](../../.images/gcp-devcontainer-architecture.svg)
1214

1315
## Prerequisites

registry/coder/templates/gcp-linux/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags: [vm, linux, gcp]
88

99
# Remote Development on Google Compute Engine (Linux)
1010

11+
Provision Google Compute Engine instances as Coder workspaces
12+
1113
## Prerequisites
1214

1315
### Authentication

registry/coder/templates/gcp-vm-container/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags: [vm-container, linux, gcp]
88

99
# Remote Development on Google Compute Engine (VM Container)
1010

11+
Provision Google Compute Engine instances as Coder workspaces.
12+
1113
## Prerequisites
1214

1315
### Authentication

registry/coder/templates/gcp-windows/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags: [vm, windows, gcp]
88

99
# Remote Development on Google Compute Engine (Windows)
1010

11+
Provision Google Compute Engine instances as Coder workspaces
12+
1113
## Prerequisites
1214

1315
### Authentication

registry/coder/templates/kubernetes-envbox/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags: [kubernetes, containers, docker-in-docker]
88

99
# envbox
1010

11+
Provision envbox pods as Coder workspaces
12+
1113
## Introduction
1214

1315
`envbox` is an image that enables creating non-privileged containers capable of running system-level software (e.g. `dockerd`, `systemd`, etc) in Kubernetes.

registry/sharkymark/templates/docker-claude/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
---
22
display_name: "Claude Code AI Agent Template"
3-
description: The goal is to try the experimental ai agent integration with Claude CodeAI agent
3+
description: An experimental AI agent integration with Claude CodeAI agent
44
icon: "../../../../.icons/claude.svg"
55
verified: false
66
tags: ["ai", "docker", "container", "claude", "agent", "tasks"]
77
---
88

9-
# ai agent template for a workspace in a container on a Docker host
9+
# AI agent template for a workspace in a container on a Docker host
1010

11-
### Docker image
11+
An experimental AI agent integration with Claude CodeAI agent
12+
13+
## Docker image
1214

1315
1. Based on Coder-managed image `codercom/example-universal:ubuntu`
1416

1517
[Image on DockerHub](https://hub.docker.com/r/codercom/example-universal)
1618

17-
### Apps included
19+
## Apps included
1820

1921
1. A web-based terminal
2022
1. code-server Web IDE
2123
1. A [sample app](https://github.com/gothinkster/realworld) to test the environment
2224
1. [Claude Code AI agent](https://www.anthropic.com/claude-code) to assist with development tasks
2325

24-
### Resources
26+
## Resources
2527

2628
[Coder docs on AI agents and tasks](https://coder.com/docs/ai-coder/tasks)
2729

0 commit comments

Comments
 (0)