Release fix: lowercase GHCR tags and bump to v0.1.1 #9
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 | |
| on: | |
| push: | |
| tags: | |
| - "v*" | |
| permissions: | |
| contents: write | |
| id-token: write | |
| packages: write | |
| jobs: | |
| # ── Gate: only release from master ────────────────────────────────── | |
| check-branch: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Verify tag is on master | |
| run: | | |
| TAG_COMMIT=$(git rev-list -n 1 "$GITHUB_REF") | |
| if ! git branch -r --contains "$TAG_COMMIT" | grep -q 'origin/master'; then | |
| echo "::error::Tag $GITHUB_REF_NAME is not on the master branch. Releases must be tagged on master." | |
| exit 1 | |
| fi | |
| # ── Step 1: Run tests ────────────────────────────────────────────── | |
| test: | |
| needs: check-branch | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12", "3.13"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - run: pip install -e ".[dev]" | |
| - run: pytest --cov=FasterAPI --cov-report=term-missing | |
| # ── Step 2: Build wheel + sdist ──────────────────────────────────── | |
| build: | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.13" | |
| - name: Install build tools | |
| run: pip install build | |
| - name: Build wheel and sdist | |
| run: python -m build | |
| - name: Upload build artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| # ── Step 3: Publish to PyPI via trusted publishing (OIDC) ────────── | |
| publish-pypi: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: pypi | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| # ── Step 4: Publish Docker image to GitHub Packages (ghcr.io) ────── | |
| publish-docker: | |
| needs: test | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| packages: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Log in to GitHub Container Registry | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Extract version from tag | |
| id: version | |
| run: echo "tag=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT" | |
| - name: Normalize owner to lowercase | |
| id: owner | |
| run: echo "owner_lc=${GITHUB_REPOSITORY_OWNER,,}" >> "$GITHUB_OUTPUT" | |
| - name: Build and push Docker image | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| push: true | |
| tags: | | |
| ghcr.io/${{ steps.owner.outputs.owner_lc }}/fasterapi:${{ steps.version.outputs.tag }} | |
| ghcr.io/${{ steps.owner.outputs.owner_lc }}/fasterapi:latest | |
| # ── Step 5: Create GitHub Release with artifacts ─────────────────── | |
| github-release: | |
| needs: [build, publish-pypi, publish-docker] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - name: Create GitHub Release | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| files: dist/* | |
| body: | | |
| # FasterAPI ${{ github.ref_name }} | |
| **A high-performance ASGI web framework — drop-in FastAPI replacement.** | |
| ```bash | |
| pip install faster-api-web | |
| ``` | |
| --- | |
| ## 5 Key Innovations | |
| ### 1. Radix Tree Router — 7.6x faster routing | |
| O(k) lookups regardless of route count. **1,104,318 ops/s vs 144,822 ops/s** (regex). | |
| ### 2. msgspec (Rust-backed) — 9.4x faster JSON encoding | |
| Dict → bytes in a single C call. **6,317,891 ops/s vs 670,234 ops/s**. | |
| ### 3. Compiled Dependency Injection — zero per-request introspection | |
| Handler signatures compiled once at startup. Eliminates ~80% of per-request framework overhead. | |
| ### 4. uvloop — C-powered event loop | |
| libuv-backed (same engine as Node.js). All I/O scheduling in C. | |
| ### 5. Lazy Request Parsing — only parse what you use | |
| Headers, query params, cookies parsed on first access only. | |
| --- | |
| ## Benchmarks (Python 3.13.7) | |
| | Endpoint | FasterAPI | FastAPI | Speedup | | |
| |---|---|---|---| | |
| | `GET /health` | **335,612 req/s** | 49,005 req/s | **6.85x** | | |
| | `GET /users/{id}` | **282,835 req/s** | 32,391 req/s | **8.73x** | | |
| | `POST /users` | **193,225 req/s** | 27,031 req/s | **7.15x** | | |
| [Full benchmarks →](https://github.com/FasterApiWeb/FasterAPI#benchmarks) | |
| --- | |
| ## Install | |
| ```bash | |
| pip install faster-api-web # core | |
| pip install faster-api-web[all] # + uvloop | |
| ``` | |
| ## Docker | |
| ```bash | |
| docker pull ghcr.io/fasterapiweb/fasterapi:latest | |
| ``` |