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
4 changes: 0 additions & 4 deletions .github/rulesets/gitflow-main.overlay.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@
"context": "Formatting / Run Prettier Check",
"integration_id": 15368
},
{
"context": "JSON Schema / Check Schema Docs",
"integration_id": 15368
},
{
"context": "JSON Schema / Run JSON validator",
"integration_id": 15368
Expand Down
4 changes: 0 additions & 4 deletions .github/rulesets/gitflow-production.overlay.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@
"context": "Formatting / Run Prettier Check",
"integration_id": 15368
},
{
"context": "JSON Schema / Check Schema Docs",
"integration_id": 15368
},
{
"context": "JSON Schema / Run JSON validator",
"integration_id": 15368
Expand Down
36 changes: 0 additions & 36 deletions .github/workflows/node-json-schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,42 +42,6 @@ jobs:
VITE_INCLUDE_INVALID: ${{ steps.set-include.outputs.vite-include-invalid }}
run: npm run schema:check

schema-docs:
name: "Check Schema Docs"
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v7

- name: Setup Node.js
uses: actions/setup-node@v7
with:
node-version-file: .nvmrc
cache: "npm"
cache-dependency-path: package-lock.json

- name: Install dependencies
run: npm ci

- name: Run JSON schema render
run: npm run schema:generate:docs

- name: Compare Results
run: |
git add --all
changes=$(git diff-index HEAD --name-only -- $OUTPUTS)
if [ -n "$changes" ]; then
echo "Changes found after documenting."
echo "$changes"
echo "Please update documentation."
git --no-pager diff HEAD
exit 1
else
echo "No changes found after documenting."
exit 0
fi

types-check:
name: "Check generated types"
runs-on: ubuntu-latest
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,5 @@ yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Python venv
.venv/

# Generated/copied files
public/data/**/*
2 changes: 0 additions & 2 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
.venv
dist
Comment thread
AlexAxthelm marked this conversation as resolved.
public/schema.html
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,6 @@ npm run lint:fix
npm run format
```

## Documentation

### JSON Schema

To render JSON Schema documentation (available in-app at `/schema.html` route), run `npm run docs:json:schema`, which invokes the `scripts/generate-schema-docs.sh`. This script creates and activates a python virtual environment, and renders the `public/schema.html` file, which will be picked up by the build process.

There is a GitHub workflow (`schema-docs` in `.github/workflows/node-json-schema.yml`) to check that the documentation and the schema do not diverge.

## Releases

This project uses [`semantic-release`](https://semantic-release.gitbook.io/semantic-release) to manage release versions.
Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
"schema:check": "npx ts-node --esm scripts/schema-check-files.ts src/data testdata/valid",
"schema:check:srcdata": "npx ts-node --esm scripts/schema-check-files.ts src/data",
"schema:check:testdata": "npx ts-node --esm scripts/schema-check-files.ts testdata/valid",
"schema:generate": "npm run schema:generate:types && npm run schema:generate:docs",
"schema:generate:docs": "scripts/generate-schema-docs.sh",
"schema:generate": "npm run schema:generate:types",
"schema:generate:types": "npx ts-node --esm scripts/generate-types.ts && prettier --write \"src/types/**/*.d.ts\"",
"test": "vitest run",
"test:watch": "vitest"
Expand Down
Loading
Loading