Releases

What we publishCopy Anchor Link

On each v* tag, GitHub Actions builds a source distribution:

• Asset: xperf-<tag>-packages.tar.gz (example: xperf-v0.1.0-packages.tar.gz)
• Contents: packages/, docs/, site-app/, pages/, mkdocs.yml, root docs (README.md, LICENSE, NOTICE, AGENT.md, CONTRIBUTING.md, CHANGELOG.md, CODE_OF_CONDUCT.md, SECURITY.md), and scripts/
• Checksum: xperf-<tag>-packages.tar.gz.sha256

Corpora are not packaged in the source tarball. No bench binaries. No npm / crates.io / Maven uploads in v0.1.

What we do not publish (yet)Copy Anchor Link

How to cut a releaseCopy Anchor Link

1. Land the change on main (CI green).
2. Tag: git tag v0.1.0 && git push origin v0.1.0
3. Workflow release.yml runs scripts/pack-source-dist.sh, uploads assets, creates the GitHub Release.

Local dry-run: bash scripts/pack-source-dist.sh v0.1.0 /tmp/xperf-dist

workflow_dispatch can re-run packaging without a new tag.

Documentation siteCopy Anchor Link

GitHub Pages builds the guides from main. Workflow: pages.yml. The source tarball does not contain the generated HTML.

The build reads the repository name into the site URL (https://<owner>.github.io/<repo>/). Update the README link if the repository is renamed.

Local preview:

bash scripts/build-pages.sh serve

Open http://localhost:3000/. Needs Node.js 22 or newer. The command copies the Markdown into site-app/content (gitignored) and starts the docs app. The first page you open is compiled then.

The sidebar language control is English / 中文. English pages stay at /. Chinese pages are under /zh/. A page without a Chinese translation stays in English and says so.

CI vs ReleaseCopy Anchor Link