Repository navigation
0.136.0: schema-dist serials 137 and 138; layout_by_links_3d lays out… #217
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: release | |
| # Publishes onlyworlds to PyPI when a version tag (v0.1.1) is pushed, through PyPI's trusted | |
| # publishing: GitHub proves this workflow's identity to PyPI (OIDC), so no PyPI token exists | |
| # anywhere. Set up once on pypi.org, the onlyworlds project, Publishing, "Add a trusted | |
| # publisher": GitHub, owner OnlyWorlds, repository python-sdk, workflow release.yml, | |
| # environment pypi. | |
| # | |
| # The gates run first and a red one stops the publish. After the publish the job reads PyPI | |
| # back: the version is live, its files have the sha256 of the ones built here, and a clean | |
| # install from PyPI reads the public demo world. | |
| # | |
| # Releases are the maintainer's (Titus, 2026-10-11). | |
| # | |
| # Once PyPI serves it, a last job makes the tag a GitHub release, its body the version's | |
| # CHANGELOG entry: the shared What's new page reads GitHub releases. | |
| on: | |
| push: | |
| tags: ['v*'] | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: release | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - uses: astral-sh/setup-uv@v7 | |
| - name: The tag names the version the package carries | |
| run: | | |
| v="$(sed -n 's/^__version__ = "\(.*\)"$/\1/p' src/onlyworlds/_version.py)" | |
| if [ "v$v" != "$GITHUB_REF_NAME" ]; then | |
| echo "tag $GITHUB_REF_NAME, but _version.py says $v"; exit 1 | |
| fi | |
| if curl -sf "https://pypi.org/pypi/onlyworlds/$v/json" > /dev/null; then | |
| echo "$v is already on PyPI"; exit 1 | |
| fi | |
| # Every release is written up where its users look (ruled 2026-10-20) | |
| - name: The changelog has this version's entry | |
| run: | | |
| v="${GITHUB_REF_NAME#v}" | |
| if ! awk -v v="$v" '$1=="##" && $2==v {f=1} END {exit !f}' CHANGELOG.md; then | |
| echo "CHANGELOG.md has no '## $v' entry: write it, then tag"; exit 1 | |
| fi | |
| - name: The entry carries no crew words (it becomes the public release notes; ruled 2026-10-24) | |
| run: | | |
| v="${GITHUB_REF_NAME#v}" | |
| awk -v h="$v" '$1=="##" { if (f) exit; if ($2==h) { f=1; next } } f' CHANGELOG.md > entry.md | |
| if ! python scripts/public_words.py entry.md; then | |
| echo "the $v entry names someone inside the team or points at an internal room or tracker (above): say the rule and its date instead"; exit 1 | |
| fi | |
| - run: uv sync --locked | |
| - run: uv run pytest -q | |
| - run: uv run ruff check . | |
| - run: uv run mypy --strict src tests | |
| - run: uv run python codegen/generate_schema.py --check | |
| - run: uv run python codegen/generate_tools.py --check | |
| - run: uv run python codegen/generate_anchors.py --check | |
| # Published text names no one inside the team and points at no internal room or tracker. | |
| - run: uv run python scripts/public_words.py | |
| - run: uv build | |
| - run: uvx twine check dist/* | |
| # The suite once more, against the wheel this job uploads: the build backend is not pinned by the | |
| # lockfile, so this wheel is not CI's. The project leaves the environment and the wheel takes its place. | |
| - run: uv sync --locked --no-install-project | |
| - run: uv pip install --no-deps dist/*.whl | |
| - run: uv run --no-sync python -I -c "import onlyworlds; f = onlyworlds.__file__; assert '/site-packages/' in f, f; print(f)" | |
| - run: uv run --no-sync pytest -q | |
| - uses: actions/upload-artifact@v7 | |
| with: | |
| name: dist | |
| path: dist/ | |
| publish: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: pypi | |
| permissions: | |
| id-token: write | |
| steps: | |
| - uses: actions/download-artifact@v8 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - uses: pypa/gh-action-pypi-publish@release/v1 | |
| verify: | |
| needs: publish | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/download-artifact@v8 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - uses: astral-sh/setup-uv@v7 | |
| - name: Read it back from PyPI | |
| run: | | |
| v="${GITHUB_REF_NAME#v}" | |
| for i in 1 2 3 4 5 6 7 8 9 10; do | |
| curl -sf "https://pypi.org/pypi/onlyworlds/$v/json" > meta.json && break | |
| echo "not visible yet ($i)"; sleep 15 | |
| done | |
| python3 - "$v" <<'PY' | |
| import hashlib, json, pathlib, sys | |
| meta = json.load(open("meta.json")) | |
| served = {u["filename"]: u["digests"]["sha256"] for u in meta["urls"]} | |
| built = {p.name: hashlib.sha256(p.read_bytes()).hexdigest() for p in pathlib.Path("dist").iterdir()} | |
| if served != built: | |
| print("PyPI serves", served, "but this run built", built) | |
| sys.exit(1) | |
| print(f"PyPI serves {sys.argv[1]}: {len(built)} files, identical to this run's build") | |
| PY | |
| - name: A clean install reads the demo world | |
| run: | | |
| v="${GITHUB_REF_NAME#v}" | |
| uv venv /tmp/clean | |
| # PyPI's index can trail an upload by a minute (0.5.0's first verify, 2026-10-17): wait for it, then fail. | |
| for i in 1 2 3 4 5 6 7 8; do | |
| uv pip install --python /tmp/clean/bin/python --no-cache "onlyworlds==$v" && break | |
| [ "$i" = 8 ] && exit 1 | |
| sleep 20 | |
| done | |
| /tmp/clean/bin/python -I -c " | |
| import onlyworlds | |
| from onlyworlds import Client | |
| assert onlyworlds.__version__ == '$v', onlyworlds.__version__ | |
| print(Client('0000000001').get_world()['name']) | |
| " | |
| github-release: | |
| needs: verify | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: The tag becomes a GitHub release, its body this version's CHANGELOG entry | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| v="${GITHUB_REF_NAME#v}" | |
| awk -v h="$v" '$1=="##" { if (f) exit; if ($2==h) { f=1; next } } f' CHANGELOG.md > notes.md | |
| grep -q '[^[:space:]]' notes.md || { echo "CHANGELOG.md's '## $v' entry is empty"; exit 1; } | |
| gh release create "$GITHUB_REF_NAME" --verify-tag --title "onlyworlds $v" --notes-file notes.md |