agentflowkit 0.6.1__tar.gz → 0.7.0__tar.gz

agentflowkit-0.7.0/.github/pull_request_template.md

@@ -0,0 +1,27 @@
+# What
+
+<!-- One or two sentences: what changes for a user of the library? -->
+
+# Why
+
+<!-- The problem this solves. Link the issue if there is one. -->
+
+# How it was verified
+
+<!-- Paste the actual output, not "tests pass". -->
+
+```
+ruff check src/ tests/ examples/ benchmarks/ scripts/
+mypy src/agentflow/
+pytest                      # includes the 90% coverage gate
+```
+
+# Checklist
+
+- [ ] Lint, typecheck, and the full suite are green locally (output pasted above)
+- [ ] New behaviour has tests — happy path **and** at least one failure path
+- [ ] `CHANGELOG.md` `[Unreleased]` updated
+- [ ] Public API change? `PUBLIC_API.md` updated, and a deprecation shim if it breaks
+- [ ] Hard-to-reverse decision? An ADR added under `docs/adr/`
+- [ ] Docs updated (`README.md`, `docs/`) if commands, config, or behaviour changed
+- [ ] No secrets, debug leftovers, or unrelated drive-by changes in the diff

{agentflowkit-0.6.1 → agentflowkit-0.7.0}/.github/workflows/ci.yml

@@ -1,81 +1,113 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  lint:
-    name: Lint & Type Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Install dev dependencies
-        run: pip install -e ".[dev]"
-
-      - name: Run ruff
-        run: ruff check src/ tests/ examples/ benchmarks/
-
-      - name: Run mypy
-        run: mypy src/agentflow/
-
-  test:
-    name: Tests (Python ${{ matrix.python-version }})
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: pip install -e ".[dev]"
-
-      - name: Run tests with coverage
-        run: pytest tests/ -v --cov=agentflow --cov-report=xml --cov-report=term-missing
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          file: ./coverage.xml
-          fail_ci_if_error: false
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  build:
-    name: Build Distribution
-    runs-on: ubuntu-latest
-    needs: [lint, test]
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Install build tools
-        run: pip install build
-
-      - name: Build wheel and sdist
-        run: python -m build
-
-      - name: Check distributions
-        run: |
-          pip install twine
-          twine check dist/*
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+# A new push makes the previous run's result irrelevant — don't pay for it.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint & Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run ruff
+        run: ruff check src/ tests/ examples/ benchmarks/
+
+      - name: Run mypy
+        run: mypy src/agentflow/
+
+  test:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # otel and mqtt are installed so contrib/otel.py and triggers.py are
+      # actually exercised — without them those modules are skipped and the
+      # coverage gate reports on a smaller package than the one we ship.
+      - name: Install dependencies
+        run: pip install -e ".[dev,otel,mqtt]"
+
+      - name: Run tests with coverage
+        run: pytest tests/ -v --cov=agentflow --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  build:
+    name: Build Distribution
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Check distributions
+        run: |
+          pip install twine
+          twine check dist/*
+
+      # The published sdist once shipped a stray local directory; assert the
+      # archive contains only what the package is supposed to contain.
+      - name: Check the sdist has no stray files
+        run: python scripts/check_sdist.py
+
+  docs:
+    name: Docs Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install docs dependencies
+        run: pip install -e ".[docs]"
+
+      # --strict fails on a broken reference or a page missing from the nav,
+      # so a docs break is caught on the PR instead of on the live site.
+      - name: Build the documentation
+        run: mkdocs build --strict