Maintenance Guide

This document is for repository maintainers and code contributors. If you only want to submit or revise public site content, see the Contribution Guide.

Workspace Structure

Workspace Packages

• docs/: the VitePress application, including documentation and online tools
• packages/compat-finder/: the compatibility troubleshooting library and CLI published to npm
• packages/graphwar-killer-wasm/: the private AssemblyScript/WASM kernel used by Graphwar Killer
• packages/graphwar-agent/: a Java agent that exposes a local HTTP API for the official Graphwar client

Workspace relationships:

docs
├── depends on compat-finder
└── depends on graphwar-killer-wasm

graphwar-agent
└── independent; sync:public copies its build artifacts into docs/public/

See the README in each package directory for its behavior, usage, and constraints.

Repository Directories

• .changeset/: Changesets versioning and release notes
• .github/: GitHub Actions workflows and GitHub project configuration
• scripts/: repository-level orchestration scripts for formatting, testing, and other tasks
• tsconfig/: shared base configurations for the TypeScript projects

Development Environment

Install Dependencies

Install Node.js and pnpm first, then run this in the repository root:

pnpm install

If you need to format Java code or build graphwar-agent, make sure java, javac, and jar are available on PATH. JDK 21 is recommended and is also used in CI.

Common Commands

Docs Site

• Develop: pnpm docs:watch
• Build: pnpm docs:build
• Preview: pnpm docs:preview

All three commands first build the required workspace dependencies; development mode then watches the dependencies and site in parallel.

Package Commands

Run package scripts with pnpm --filter PACKAGE SCRIPT, for example pnpm --filter compat-finder test. Available scripts:

• compat-finder: cli, build, watch, test
• graphwar-killer-wasm: build, watch, test
• graphwar-agent: build, openapi:test, test
• Build the agent and copy it into the docs site: pnpm --filter graphwar-agent build && pnpm --filter graphwar-agent sync:public

Local Checks

• Format files: pnpm fmt. Java files use google-java-format in AOSP style, while other supported files use oxfmt; the formatter jar is cached under .cache/google-java-format/.
• Run linting and type checks: pnpm lint
• Run all tests: pnpm test

lint builds the docs dependencies before running checks in parallel; test builds the shared WASM once before running the test suites in parallel.

Changesets

• Create a release note entry: pnpm changeset
• Add a changeset when a change affects any published workspace package; do not add one for docs-only changes, public content edits, or internal cleanup that does not affect published package behavior
• Follow the prompt to select the affected published package and the appropriate semver bump: patch, minor, or major
• Commit the generated .changeset/*.md file together with the code changes

CI Checks

Repository-wide Checks

nodejs-ci.yml runs on pull requests and pushes to main. It mainly covers:

• pnpm fmt
• pnpm lint
• pnpm test

Formatting and some auto-fix steps may commit corrections back automatically when the PR branch is in this repository. When the PR branch is in a fork, CI runs checks only; if fixes are produced, CI uploads ci-autofix.patch. Contributors can copy the patch link from the CI job summary and run the matching commands locally on the PR branch.

Linux / macOS:

curl -L -o ci-autofix.patch "<ci-autofix.patch link>" && git apply ci-autofix.patch

Windows PowerShell:

Invoke-WebRequest -Uri "<ci-autofix.patch link>" -OutFile ci-autofix.patch; git apply ci-autofix.patch

PR Build Checks

• pr-docs-build.yml: verifies that the docs site builds successfully
• pr-compat-finder-build.yml: verifies that the compat-finder package builds successfully

Related Documentation

If you are editing public content pages or tool documentation, also refer to:

• the Contribution Guide
• the README.md file in the relevant directory when available

Release Guide

See the Release Guide for release flow, versioning rules, and release PR behavior.