Skip to content

chore: add CI step for validating contributor READMEs #1

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

Merged
merged 30 commits into from
Apr 14, 2025
Merged

Conversation

Parkreiner
Copy link
Member

@Parkreiner Parkreiner commented Apr 9, 2025

Closes coder/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

@Parkreiner Parkreiner requested a review from f0ssel April 9, 2025 15:33
@Parkreiner Parkreiner self-assigned this Apr 9, 2025
@Parkreiner Parkreiner removed the request for review from f0ssel April 9, 2025 15:34
Comment on lines +11 to +13
# Coder

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

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

@Parkreiner Parkreiner requested a review from f0ssel April 9, 2025 15:36
Copy link
Collaborator

@f0ssel f0ssel left a comment

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 on lines 1 to 7
---
display_name: Nataindata
bio: Data engineer
github: nataindata
website: https://www.nataindata.com
status: partner
---
Copy link
Collaborator

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?

Copy link
Collaborator

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?

Copy link
Member Author

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.

@Parkreiner Parkreiner requested a review from f0ssel April 14, 2025 13:52
Copy link
Collaborator

@f0ssel f0ssel left a comment

Choose a reason for hiding this comment

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

Clean!

@Parkreiner Parkreiner merged commit 7fd409f into main Apr 14, 2025
1 check passed
@Parkreiner Parkreiner deleted the mes/setup branch April 14, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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