Skip to content

chore: add CI step for validating contributor READMEs - #1

Merged
buenos-nachos merged 30 commits into
mainfrom
mes/setup
Apr 14, 2025
Merged

chore: add CI step for validating contributor READMEs#1
buenos-nachos merged 30 commits into
mainfrom
mes/setup

Conversation

@buenos-nachos

@buenos-nachosbuenos-nachos commented Apr 9, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Closescoder/internal#530

Changes made

  • Created top-level test directories for Coder and NataInData (a developer who contributed a module for us in the past)
  • Created Go script for validating the structure of each README, while being as granular as possible with any errors for better feedback
  • Added CI step for running the script

Notes

  • I did a good bit of manual testing, but I am planning to circle back with a follow-up PR to add proper tests for the script functionality. I might push that off until after the majority of the new Registry work is done, though
  • Not 100% sold on the structure of the Go directories. That's likely to change as I add more code for validating the modules and templates

@buenos-nachosbuenos-nachos self-assigned this Apr 9, 2025
@buenos-nachos
buenos-nachos removed the request for review from f0sselApril 9, 2025 15:34
buenos-nachos
buenos-nachos commented Apr 9, 2025
View reviewed changes
Comment threadregistry/coder/README.md
Comment on lines +11 to +13
# Coder

Coder provisions cloud development environments via Terraform, supporting Linux, macOS, Windows, X86, ARM, Kubernetes and more.

@buenos-nachosbuenos-nachosApr 9, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hasn't come up in any of the conversations yet, but I think that it's safe to give developers the freedom to throw whatever they want in the body. We'll just make sure the code always ignores it

matifali
matifali reviewed Apr 9, 2025
View reviewed changes
Comment thread.github/workflows/ci.yaml Outdated
f0ssel
f0ssel requested changes Apr 10, 2025
View reviewed changes

@f0sself0ssel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mainly just code styling changes, but overall this looks like a great start for validation.

Comment threadregistry/nataindata/README.md
Comment on lines +1 to +7
---
display_name: Nataindata
bio: Data engineer
github: nataindata
website: https://www.nataindata.com
status: partner
---

@f0sself0sselApr 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's not a lot of work, could you drop a screenshot or mock of what the page should looks like with just the bare minimum frontmatter filled out?

@f0sself0sselApr 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are they a partner? Shouldn't this be like community or something?

@buenos-nachosbuenos-nachosApr 10, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, updated the field, and I'll make a quick mockup tomorrow morning.

Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
f0ssel
f0ssel reviewed Apr 11, 2025
View reviewed changes
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go Outdated
Comment threadscripts/validate-contributor-readmes/main.go
f0ssel
f0ssel approved these changes Apr 14, 2025
View reviewed changes

@f0sself0ssel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean!

@buenos-nachos
buenos-nachos merged commit 7fd409f into mainApr 14, 2025
@buenos-nachos
buenos-nachos deleted the mes/setup branch April 14, 2025 17:48
@DevelopmentCatsDevelopmentCats mentioned this pull request Jul 9, 2025
Open
@DevelopmentCatsDevelopmentCats mentioned this pull request May 4, 2026
Merged
@DevelopmentCatsDevelopmentCats mentioned this pull request Jun 2, 2026
Closed
@35C4n0r35C4n0r mentioned this pull request Jul 7, 2026
Merged
7 tasks
@matifalimatifali mentioned this pull request Jul 20, 2026
Merged
DevelopmentCats pushed a commit that referenced this pull request Jul 20, 2026
@matifali
feat(matifali): add Omnigent Docker template (#1022)
22dad63
## Summary
Adds an Omnigent Docker template under the personal `matifali`
namespace, combining Omnigent, Claude Code, Codex, Coder AI Gateway, and
a shallow clone of `github.com/coder/coder`.
This was extracted from #925 so the reusable Omnigent module and the
opinionated Docker template can be reviewed independently.
## Changes
- Add the template under `registry/matifali/templates/omnigent-docker`.
- Add the `matifali` contributor profile and link the hosted Omnigent
module and Docker template.
- Configure Claude Code and Codex through Coder AI Gateway.
- Use compatible module constraints so minor and patch releases are
selected automatically.
- Install shared dependencies required by the AI tools on the
Ubuntu-based image.
- Coordinate repository cloning, AI tool setup, and Omnigent startup
with `coder exp sync`.
- Add the Omnigent registry icon.
## Validation
- `terraform fmt -check -recursive
registry/matifali/templates/omnigent-docker`
- Imported the exact PR template as Coder template version
`e77335c8-2899-449e-8fb6-fa7e4c516b99`.
- Terraform initialized and planned successfully, resolving:
- `matifali/omnigent` `0.0.1`
- `coder/git-clone` `2.0.2`
- `coder/claude-code` `5.2.0`
- `coder-labs/codex` `5.3.0`
- Created workspace `test-omnigent-docker-pr-1022` from the imported
template.
- Workspace build #1 succeeded with 16 resources created and reached
`ready`.
- Verified:
- Omnigent app health is `healthy`.
- `GET /health` returns `{ "status": "ok" }`.
- The Coder repository was cloned successfully.
- Claude Code `2.1.215`, Codex CLI `0.144.6`, and Omnigent `0.5.1` are
installed.
- Omnigent server and host processes are running.
- The Omnigent host is connected to the local server.
- All startup scripts completed successfully.
Continuation of #925
> 🤖 This PR was created with the help of Coder Agents, and needs a human
review. 🧑💻
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matifalimatifalimatifali left review comments
@f0sself0sself0ssel approved these changes

Assignees

@buenos-nachosbuenos-nachos

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create new hub repository for modules/templates/future Coder resources

3 participants

@buenos-nachos@matifali@f0ssel