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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
96c20c4
chore: add sample README
Parkreiner Apr 8, 2025
a5c4495
wip: commit progress on CI validation script
Parkreiner Apr 8, 2025
20204b0
chore: add extra sample data file
Parkreiner Apr 8, 2025
902b32f
wip: commit more progress on script
Parkreiner Apr 8, 2025
1906520
chore: add logs for better feedback
Parkreiner Apr 8, 2025
da735da
fix: remove parsing bugs
Parkreiner Apr 8, 2025
b191321
fix: make logging better
Parkreiner Apr 8, 2025
629f4b3
chore: rename directory for script
Parkreiner Apr 8, 2025
2b9da92
refactor: remove goto statements
Parkreiner Apr 8, 2025
23f1cee
fix: remove accidental segfault
Parkreiner Apr 8, 2025
e20e679
wip: scaffold relative URL validation
Parkreiner Apr 8, 2025
df2e47e
refactor: remove unnecessary intermediary data types
Parkreiner Apr 8, 2025
36ebd8d
fix: update script to be runnable from root directory
Parkreiner Apr 8, 2025
c3f998d
refactor: rename script
Parkreiner Apr 8, 2025
9e48eb8
refactor: reorganize scripts again
Parkreiner Apr 8, 2025
3b9ec5e
chore: finish initial version of validation script
Parkreiner Apr 8, 2025
88f7be2
chore: set up initial version of CI
Parkreiner Apr 9, 2025
e035f1f
chore: beef up CI
Parkreiner Apr 9, 2025
3b9c01e
fix: ensure relative avatars keep small scope
Parkreiner Apr 9, 2025
bc4bbda
fix: remove unnecessary matrix
Parkreiner Apr 9, 2025
abf9815
fix: update static files
Parkreiner Apr 10, 2025
affc506
refactor: split validation function into smaller pieces
Parkreiner Apr 10, 2025
65fb7bc
refactor: standardize how errors are defined
Parkreiner Apr 11, 2025
96fa5d4
refactor: apply majority of feedback
Parkreiner Apr 11, 2025
5c45642
refactor: split off another function
Parkreiner Apr 11, 2025
ffd9861
refactor: extract pseudo-constants
Parkreiner Apr 14, 2025
bdf9c5f
refactor: update namespacing
Parkreiner Apr 14, 2025
39b264a
refactor: split up package boundaries
Parkreiner Apr 14, 2025
a2c246e
refactor: split out error func
Parkreiner Apr 14, 2025
50d651c
fix: update CI step
Parkreiner Apr 14, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: CI
on:
pull_request:
branches: [main]
# Cancel in-progress runs for pull requests when developers push new changes
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
jobs:
validate-contributors:
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 ./scripts/contributors && ./contributors
- name: Remove build file artifact
run: rm ./contributors
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,6 @@ dist
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# Script output
/contributors
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module coder.com/coder-registry

go 1.23.2

require gopkg.in/yaml.v3 v3.0.1
4 changes: 4 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
13 changes: 13 additions & 0 deletions registry/coder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
display_name: Coder
bio: Coder provisions cloud development environments via Terraform, supporting Linux, macOS, Windows, X86, ARM, Kubernetes and more.
github: coder
linkedin: https://www.linkedin.com/company/coderhq
website: https://www.coder.com
support_email: support@coder.com
status: official
---

# Coder

Coder provisions cloud development environments via Terraform, supporting Linux, macOS, Windows, X86, ARM, Kubernetes and more.
Comment on lines +11 to +13
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

7 changes: 7 additions & 0 deletions registry/nataindata/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
display_name: Nataindata
bio: Data engineer
github: nataindata
website: https://www.nataindata.com
status: community
---
Loading