Files
paperspec/.gitea/workflows/publish.yml
T
alexmandClaude 30d310f64d Publish the package and its documentation, and move to the papers organization
Add the Zensical documentation of the Python package (docs/package, built by the docs
workflow), merge the standard publish workflow with the setuptools-scm tag check, add the
SPDX header rule to ruff, restructure the README, and point every repository and registry
address at the Gitea organization papers.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01B8cL4zN4XpaQF5cBtASzfq
2026-10-19 04:23:49 -04:00

85 lines
3.8 KiB
YAML

# Publishes the paperspec wheel and sdist to this Gitea instance's PyPI registry when a version tag (v1.2.3) is pushed,
# and creates the Gitea release with both files attached. The version is the tag's: setuptools-scm computes it
# from git (hence the full-history checkout), and the job refuses to upload unless the built version equals the
# tag, so tag the commit you mean to release. Run it by hand only on a tag.
# Needs the organization secrets PACKAGE_USER and PACKAGE_TOKEN (a token with the write:package scope).
# Install side: README.md ("Installing") and deploy/README.md name the registry index.
name: publish
on:
push:
tags: ["v[0-9]*"]
workflow_dispatch:
permissions:
contents: read
concurrency:
group: publish-${{ gitea.ref }}
cancel-in-progress: false
defaults:
run:
shell: bash
jobs:
publish:
runs-on: linux-base
container:
image: git.scient.ing/infra/linux-base:26.10.7
timeout-minutes: 30
env:
REGISTRY: ${{ github.server_url }}/api/packages/${{ github.repository_owner }}/pypi
API: ${{ github.server_url }}/api/v1/repos/${{ github.repository }}
steps:
- name: Require a version tag
run: |
if [[ "$GITHUB_REF" != refs/tags/v* ]]; then
echo "Publish runs on a version tag such as v1.2.3; $GITHUB_REF is not one."
exit 1
fi
- uses: actions/checkout@v4
with:
fetch-depth: 0
persist-credentials: false
- name: Check the repository
run: pixi run --locked check
- name: Build the sdist and wheel
run: pixi run --locked -e release dist
- name: Confirm the built version is the tag
run: |
tag="${GITHUB_REF_NAME#v}"
wheels=(dist/paperspec-*.whl)
built="$(basename "${wheels[0]}" | cut -d- -f2)"
echo "tag $GITHUB_REF_NAME, built $built"
if [ "${#wheels[@]}" -ne 1 ] || [ "$built" != "$tag" ]; then
echo "The built version is not the tag's; is the tag on the commit this job checked out?"
exit 1
fi
- name: Check the package metadata
run: pixi run --locked -e release twine check --strict dist/*
# --skip-existing makes a rerun on the same tag succeed instead of failing on the files already there.
- name: Upload to the package registry
env:
TWINE_USERNAME: ${{ secrets.PACKAGE_USER }}
TWINE_PASSWORD: ${{ secrets.PACKAGE_TOKEN }}
TWINE_REPOSITORY_URL: ${{ env.REGISTRY }}
run: |
if [ -z "$TWINE_USERNAME" ] || [ -z "$TWINE_PASSWORD" ]; then
echo "The secrets PACKAGE_USER and PACKAGE_TOKEN are not set; deploy/README.md says how."
exit 1
fi
pixi run --locked -e release twine upload --non-interactive --skip-existing dist/*
echo "Published to $REGISTRY: pip install --index-url $REGISTRY/simple/ paperspec"
- name: Create the release and attach the files
env:
TOKEN: ${{ secrets.RELEASE_TOKEN || secrets.GITHUB_TOKEN }}
run: |
# A release is a "## 0.1.0" or "### 0.1.1" heading in CHANGELOG.md; its notes run to the next heading.
notes="$(awk -v v="${GITHUB_REF_NAME#v}" '
/^##+ / { if (found) exit; if (index($0, v)) found = 1; next }
found { print }' CHANGELOG.md)"
body="$(printf '%s\n' "${notes:-See CHANGELOG.md.}" | jq -Rs .)"
release_id="$(curl -fsS -X POST "$API/releases" \
-H "Authorization: token $TOKEN" -H "Content-Type: application/json" \
-d "{\"tag_name\": \"$GITHUB_REF_NAME\", \"name\": \"$GITHUB_REF_NAME\", \"body\": $body}" | jq .id)"
for f in dist/*; do
curl -fsS -X POST "$API/releases/$release_id/assets?name=$(basename "$f")" \
-H "Authorization: token $TOKEN" -F "attachment=@$f"
done