Publishing - .gitea/workflows/publish.yml publishes paperspec to the instance's PyPI registry (/api/packages/infra/pypi) when a v* tag is pushed: it checks the repository, builds the sdist and wheel, refuses to upload unless the built version equals the tag, runs twine check --strict, and uploads with the secrets PACKAGE_USER and PACKAGE_TOKEN (--skip-existing, so a rerun on the same tag is safe). Run by hand, it refuses anything but a tag. - pixi dev environment: twine >= 6.1 (the first that reads Metadata 2.4), and `dist` (sdist and wheel) replaces the `wheel` task. - deploy/README.md: how to set up the secrets, release a version, and install from the registry with pixi, uv or pip, tying paperspec to the registry where the installer allows it. - CONTRIBUTING.md "Releasing": a tag versions the package; a format change takes the new format version as the top CHANGELOG heading, and a code-only release takes the next patch as a subsection, as 0.1.1 does. - pyproject: fallback_version 0+unknown for source trees without git; the license expression is Apache-2.0 AND CC0-1.0, for the code and the data the wheel carries. Cleanup (from an audit of every reference to the package) - spec/00 lists src/ (the package) and tools/ (how to run it), and no longer says the reference implementation is not a library. - Stale explanations fixed in pixi.toml, .gitignore, the Caddyfile, the vectors, context, sql and tools READMEs, docs/examples.md, docs/faq.md, spec/01, docs/rationale.md and docs/comparison.md: the commands, what they need (the tools extra), the fixture folder hale2026harmonic-damb, and three lines that held two sentences. - tools/README.md counts all six commands, says what needs which extra (package.validate and corrections.gate need [schema]), and that the vectors ship but the fixtures they name do not. - The CLI's install and clone hints point at the registry instructions and an https clone URL; schema.py raises an ImportError naming paperspec[schema], as crypto.py does for [crypto]. - check's Unicode check now guards the package's pinned constant. - site skips build/, dist/ and *.egg-info. - CHANGELOG 0.1.1 describes the final state. pixi run check passes (as `python -m paperspec check`); the rebuild is byte-identical. pixi.lock needs `pixi lock` for twine before pushing: the publish workflow installs with --locked. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
35 lines
1.4 KiB
Caddyfile
35 lines
1.4 KiB
Caddyfile
# Serves the paperspec website built by `paperspec site` (`pixi run site`, the `_site/` folder), copied to /srv/www/paperspec.
|
|
# The site mirrors the repository, so every schema is served at its $id and the JSON-LD context at the address
|
|
# layers name; this file sets the media types those addresses need and lets any page fetch them.
|
|
paperspec.scient.ing {
|
|
root * /srv/www/paperspec
|
|
encode zstd gzip
|
|
|
|
# Every file may be fetched from any origin: JSON-LD processors and schema validators in browsers need it.
|
|
header Access-Control-Allow-Origin "*"
|
|
header X-Content-Type-Options "nosniff"
|
|
|
|
# file_server keeps a Content-Type that is already set, so these take precedence over its defaults.
|
|
@jsonld path *.jsonld
|
|
header @jsonld Content-Type "application/ld+json"
|
|
@schema path /schemas/*.schema.json
|
|
header @schema Content-Type "application/schema+json"
|
|
@jsonl path *.jsonl
|
|
header @jsonl Content-Type "application/jsonl; charset=utf-8"
|
|
@package path *.sct.zip
|
|
header @package Content-Type "application/vnd.scienting.doc+zip"
|
|
@text path *.md *.py *.sql *.csv *.hex *.toml *.lock *.txt
|
|
header @text Content-Type "text/plain; charset=utf-8"
|
|
|
|
# Pages and the search index change with each release; data files are cached briefly too, since the
|
|
# addresses stay the same across releases while their contents may not.
|
|
header Cache-Control "public, max-age=300"
|
|
|
|
file_server
|
|
|
|
handle_errors {
|
|
rewrite * /404.html
|
|
file_server
|
|
}
|
|
}
|