Skip to content
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

Add a schema for self-reporting #1

Merged
merged 9 commits into from
Aug 3, 2024
Merged

Add a schema for self-reporting #1

merged 9 commits into from
Aug 3, 2024

Conversation

chadwhitacre
Copy link
Contributor

@chadwhitacre chadwhitacre commented Jun 25, 2024

Light-weight self-reporting is a central part of the OSS Pledge. What should the format be? Let's define it using JSON Schema for easy validation and interoperability. Going with Zod as part of Astro since that's what we've set up in this repo.

(X reachout)

System Design

  1. Companies host an osspledge.json on their own domain (think robots.txt).
  2. We have a members.csv in this repo containing slug,url for members.
  3. Joining Pledge is by PR to this repo, adding to members.csv
  4. We have a GHA automation to update src/members/{slug}.json when members.csv changes.
  5. We have another automation to update {slug}.json periodically based on modtime stored therein.

schema-v0.0.0.json Outdated Show resolved Hide resolved
schema-v0.0.0.json Outdated Show resolved Hide resolved
schema-v0.0.0.json Outdated Show resolved Hide resolved
schema-v0.0.0.json Outdated Show resolved Hide resolved
schema-v0.0.0.json Outdated Show resolved Hide resolved
@chadwhitacre
Copy link
Contributor Author

Now that we're ported to Astro I've ported this PR to Astro as well. It's going pretty well! :-)

Screenshot 2024-07-19 at 12 22 22 PM

@chadwhitacre
Copy link
Contributor Author

chadwhitacre commented Jul 22, 2024

Latest iteration in 1a198e9.

Screenshot 2024-07-22 at 12 52 14 PM

@chadwhitacre
Copy link
Contributor Author

Point from @vladh on a call to use https://en.wikipedia.org/wiki/Well-known_URI

@chadwhitacre chadwhitacre mentioned this pull request Jul 29, 2024
@vladh
Copy link
Member

vladh commented Aug 2, 2024

@chadwhitacre I might make some progress on this over the weekend if you're not opposed?

@chadwhitacre
Copy link
Contributor Author

What are you thinking of working on? The next steps I have in mind are to add real numbers for Sentry and publish the json file on open.sentry.io. The next step after that would be to write the GitHub automations to modify files under src/collections/members/ when members.csv changes and periodically (to pick up changes to json files already listed in the csv). I just pushed a couple commits to this PR that I think brings it to a spot where we could merge, and then pick up with further work in new PRs. Sound like a plan?

@vladh
Copy link
Member

vladh commented Aug 3, 2024

Sounds good, will do that!

@vladh vladh merged commit d3382f6 into main Aug 3, 2024
2 checks passed
@chadwhitacre chadwhitacre deleted the cwlw/schema branch August 27, 2024 22:37
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.

2 participants