forked from json-schema-org/website
-
-
Notifications
You must be signed in to change notification settings - Fork 0
63 lines (53 loc) · 3.28 KB
/
new-implementation.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
name: New Implementation Commenter
on:
# Careful! Do not modify this workflow to run untrusted code!
# It runs even when the base is a forked repository.
# As-is, this is intended behavior (to properly show the comment).
# See the warning here: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
pull_request_target:
types:
- opened
branches:
- main
paths:
- data/tooling-data.yaml
jobs:
comment:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: actions/github-script@v7
with:
script: |
const { data: pullRequests } = await github.rest.pulls.list({
owner: context.repo.owner,
repo: context.repo.repo,
state: 'all'
});
const userPRs = pullRequests.filter(pr => pr.user.login === context.actor);
if (userPRs.length === 0) {
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: process.env.NEW_TOOL_MESSAGE,
})
}
env:
NEW_TOOL_MESSAGE: |
Hey there 👋!
Are you an implementer of a new JSON Schema related tool, or an interested user submitting a tool you like?
If so, thanks for considering adding your tool to our collection -- and if not, sorry, I'm just a bot looking at which pages you're modifying!
Someone will review your pull request shortly.
In the interim, if you haven't already, there's a few things you might be interested in reviewing or confirming:
1. [ ] **Short description**: Tell us a small bit about your tool! We love staying up to date on what's out there, and what your intentions are in writing it.
2. [ ] **Come Join Our Slack!**: We have an `#implementers` channel for anyone interested in or building JSON Schema tooling!
An invite can be found [here](https://json-schema.org/slack) or on our homepage!
3. [ ] **Common Interfaces**: We maintain a page with some "commonly useful programming interfaces" that tooling may want to implement and present to your users.
You can find that page [here in our documentation](https://json-schema.org/implementers/interfaces).
Have a read through and consider whether you implement or should implement any of what's there.
4. [ ] **Bowtie Harness**: [Bowtie](https://github.com/bowtie-json-schema/bowtie) is a tool which gives JSON Schema users access to a huge number of different implementations across many languages, and [reports on](https://bowtie.report/) the compliance of those implementations with the JSON Schema specifications.
If it makes sense for your kind of tool, consider writing a *harness* which connects it to Bowtie. Instructions for doing so can be found in the tutorial in [Bowtie's documentation](https://docs.bowtie.report/).
If you have any questions, any feedback, or need help with the submission process, don't hesitate to reach out.
Thanks a bunch for your awesome contribution!