Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
77 changes: 0 additions & 77 deletions .circleci/config.yml

This file was deleted.

17 changes: 17 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: CI

on:
push:
branches-ignore: [master]
pull_request:

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- run: bun install
- run: bun test
- run: bun run build
- run: bun run lint
42 changes: 42 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Deploy docs to GitHub Pages

on:
push:
branches: [master]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- run: bun install
- run: bun run build
- uses: actions/jekyll-build-pages@v1
with:
source: docs
destination: ./_site
- uses: actions/upload-pages-artifact@v3
with:
path: ./_site

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deploy.outputs.page_url }}
steps:
- id: deploy
uses: actions/deploy-pages@v4
27 changes: 27 additions & 0 deletions .github/workflows/prepare_release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Create Release PR

on:
push:
branches: [master]

jobs:
prepare-release:
if: "!contains(github.event.head_commit.message, 'chore: prepare release')"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.PAT }}
- name: Configure Git
run: |
git config --global user.name "GitHub Actions"
git config --global user.email "github-actions@github.com"
- name: Install Knope
uses: knope-dev/action@v2.1.2
with:
version: 0.22.3
- run: knope prepare-release --verbose
env:
GITHUB_TOKEN: ${{ secrets.PAT }}
continue-on-error: true
32 changes: 32 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Release

on:
pull_request:
types: [closed]
branches: [master]

jobs:
release:
if: github.head_ref == 'release' && github.event.pull_request.merged == true
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Knope
uses: knope-dev/action@v2.1.2
with:
version: 0.22.3
- run: knope release --verbose
env:
GITHUB_TOKEN: ${{ secrets.PAT }}
- uses: actions/setup-node@v4
with:
node-version: "24"
registry-url: "https://registry.npmjs.org"
- uses: oven-sh/setup-bun@v2
- run: bun install
- run: bun run build:bundle
- run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.DS_Store
build/
dist/
docs/
node_modules/
generated/
.vscode/
14 changes: 11 additions & 3 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
{
"default": true,
"MD033": {
"allowed_elements": ["p", "img", "a"]
"allowed_elements": [
"p",
"img",
"a",
"span"
]
},
"MD013": false,
"MD025": false,
"MD004": false
}
"MD004": false,
"MD049": false,
"MD059": false,
"MD060": false
}
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18.13.0
24.11.0
12 changes: 12 additions & 0 deletions .prettierc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"endOfLine": "lf",
"bracketSameLine": false,
"arrowParens": "always",
"bracketSpacing": true,
"useTabs": false,
"tabWidth": 2,
"printWidth": 100,
"trailingComma": "esnext",
"singleQuote": true,
"semi": true
}
45 changes: 0 additions & 45 deletions .releaserc

This file was deleted.

22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,28 @@ You may also access specific versions of the spec by appending the version to th

`https://spec.open-rpc.org/1.0.0`

## _Announcement Recent Change_

The OpenRPC specification is now **packaged and deployed** as `@open-rpc/spec`, and it includes **versioned historical schemas**.
This allows downstream tooling and SDKs to pull specific schema versions directly from the published package.

Examples:

- `@open-rpc/spec/1_3/schema.json`
- `@open-rpc/spec/1_4/schema.json`

## Regex Change (starting 1.4)

Starting with the `1.4.x` schema line, the `openrpc` constraint moves from explicit patch-level enumeration to a regex-based version-line constraint.
This means `1.4.x` is validated as a compatibility line instead of requiring each patch version to be listed.

## ENUM Change

Historically, schema compatibility across versions was not always explicit.
To clarify behavior boundaries, version ENUMs are now treated as strict compatibility declarations: a spec version appears only when that schema behavior set explicitly supports it.

These changes are not intended to break existing valid documents, but they make version/behavior differences explicit and machine-checkable for tooling.

## Contributing

How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.
Expand Down
66 changes: 0 additions & 66 deletions bin/build.ghpages.sh

This file was deleted.

Loading