Skip to content

Commit 38c2974

Browse files
authored
Merge pull request #173 from json-schema-org/new-tooling-action
Add an automatic commenter for new tooling PRs.
2 parents f922a1e + c27b326 commit 38c2974

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: New Implementation Commenter
2+
on:
3+
pull_request:
4+
types:
5+
- opened
6+
branches:
7+
- main
8+
paths:
9+
- data/*.yml
10+
- pages/implementations/main.md
11+
12+
permissions:
13+
pull-requests: write
14+
15+
jobs:
16+
comment:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/github-script@v6
20+
with:
21+
script: |
22+
github.rest.issues.createComment({
23+
issue_number: context.issue.number,
24+
owner: context.repo.owner,
25+
repo: context.repo.repo,
26+
body: process.env.NEW_TOOL_MESSAGE,
27+
})
28+
env:
29+
NEW_TOOL_MESSAGE: |
30+
Hey there 👋!
31+
32+
Are you an implementer of a new JSON Schema related tool, or an interested user submitting a tool you like?
33+
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!
34+
35+
Someone will review your pull request shortly.
36+
37+
In the interim, if you haven't already, there's a few things you might be interested in reviewing or confirming:
38+
39+
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.
40+
2. [ ] **Come Join Our Slack!**: We have an `#implementers` channel for anyone interested in or building JSON Schema tooling!
41+
An invite can be found [here](https://json-schema.org/slack) or on our homepage!
42+
3. [ ] **Common Interfaces**: We maintain a page with some "commonly useful programming interfaces" that tooling may want to implement and present to your users.
43+
You can find that page [here in our documentation](https://json-schema.org/implementers/interfaces).
44+
Have a read through and consider whether you implement or should implement any of what's there.
45+
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.
46+
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/).
47+
48+
If you have any questions, any feedback, or need help with the submission process, don't hesitate to reach out.
49+
Thanks a bunch for your awesome contribution!

0 commit comments

Comments
 (0)