Skip to content

Commit 563b1e0

Browse files
briwardbriward
committed
Add github workflows for testing and publishing to JSR registry.
1 parent f1233f9 commit 563b1e0

6 files changed

Lines changed: 207 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in Raptor Validator
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please provide as much detail as possible.
10+
11+
- type: dropdown
12+
id: runtime
13+
attributes:
14+
label: Runtime Environment
15+
description: Which JavaScript runtime are you using?
16+
options:
17+
- Deno
18+
- Node.js
19+
- Bun
20+
- Multiple runtimes
21+
validations:
22+
required: true
23+
24+
- type: input
25+
id: version
26+
attributes:
27+
label: Validator Version
28+
description: Which version of Raptor Validator are you using?
29+
placeholder: "e.g., 0.14.0"
30+
validations:
31+
required: true
32+
33+
- type: input
34+
id: framework-version
35+
attributes:
36+
label: Framework Version
37+
description: Which version of Raptor Framework are you using?
38+
placeholder: "e.g., 0.14.0"
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: runtime-version
44+
attributes:
45+
label: Runtime Version
46+
description: Which version of your runtime are you using?
47+
placeholder: "e.g., Deno 2.1.0, Node.js 20.10.0, Bun 1.0.0"
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: description
53+
attributes:
54+
label: Bug Description
55+
description: A clear description of what the bug is
56+
placeholder: What happened? What did you expect to happen?
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: reproduction
62+
attributes:
63+
label: Minimal Reproduction
64+
description: Provide the smallest amount of code that reproduces the issue
65+
placeholder: |
66+
import { Kernel } from "@raptor/framework";
67+
import { Validator } from "@raptor/validator";
68+
69+
const app = new Kernel();
70+
71+
const validator = new Validator();
72+
73+
// Your reproduction code here
74+
render: typescript
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: expected
80+
attributes:
81+
label: Expected Behavior
82+
description: What should happen instead?
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: actual
88+
attributes:
89+
label: Actual Behavior
90+
description: What actually happens? Include error messages if applicable.
91+
validations:
92+
required: true
93+
94+
- type: textarea
95+
id: additional
96+
attributes:
97+
label: Additional Context
98+
description: Any other context, screenshots, or information that might help

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: JSR Package Page
4+
url: https://jsr.io/@raptor/validator
5+
about: View the package on JSR
6+
- name: Security Issue
7+
url: https://github.com/raptor-http/validator/security/advisories/new
8+
about: Report a security vulnerability privately

‎.github/ISSUE_TEMPLATE/documentation_issue.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Documentation Issue
2+
description: Report missing, unclear, or incorrect documentation
3+
title: "[Docs]: "
4+
labels: ["documentation", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve Raptor's documentation!
10+
11+
- type: dropdown
12+
id: category
13+
attributes:
14+
label: Documentation Type
15+
description: What kind of documentation issue is this?
16+
options:
17+
- Missing documentation
18+
- Unclear/confusing explanation
19+
- Incorrect information
20+
- Outdated information
21+
- Example needed
22+
- Typo/grammar
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: location
28+
attributes:
29+
label: Documentation Location
30+
description: Where is this documentation located?
31+
placeholder: "e.g., README.md, API docs for Kernel, jsr.io page"
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: issue
37+
attributes:
38+
label: Issue Description
39+
description: What's wrong or missing? Be specific.
40+
placeholder: The documentation doesn't explain... / The example shows... but should show...
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: suggestion
46+
attributes:
47+
label: Suggested Improvement
48+
description: How would you improve this documentation?
49+
placeholder: Could be clearer if it explained... / Would be helpful to add an example showing...
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: additional
55+
attributes:
56+
label: Additional Context
57+
description: Any other information that might help

‎.github/workflows/ci.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: ci
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
ci:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- name: clone repository
11+
uses: actions/checkout@v4
12+
13+
- name: install deno
14+
uses: denoland/setup-deno@v2
15+
with:
16+
deno-version: ${{ matrix.version }}
17+
18+
- name: check format
19+
run: deno fmt --check
20+
21+
- name: check linting
22+
run: deno lint
23+
24+
- name: run tests
25+
run: deno task test

‎.github/workflows/publish.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: publish
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: read
13+
id-token: write
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Publish to JSR
18+
run: npx jsr publish

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<a href="https://jsr.io/@raptor"><img src="https://jsr.io/badges/@raptor" alt="" /></a>
1010
</p>
1111

12-
## Raptor Pages
12+
## Raptor Pages (alpha)
1313

1414
See more information about the Raptor framework here: <a href="https://raptorjs.com">https://raptorjs.com</a>.
1515

0 commit comments

Comments
 (0)