Merge pull request #589 from Pipelex/feature/Chicago

pre-release/v0.18.0b1: Chicago

Author: lchoquel

.badges/tests.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
   "label": "tests",
-  "message": "1802",
+  "message": "2751",
   "color": "blue",
   "cacheSeconds": 300
 }

.blackboxrules

@@ -15,7 +15,7 @@
 
    This runs multiple code quality tools:
    - Pyright: Static type checking
-   - Ruff: Fix unised imports, lint, format  
+   - Ruff: Fix unused imports, lint, format  
    - Mypy: Static type checker
 
    Always fix any issues reported by these tools before proceeding.
@@ -283,7 +283,6 @@ NEVER EVER put more than one TestClass into a test module.
     - `tests/unit/` - for unit tests that test individual functions/classes in isolation
     - `tests/integration/` - for integration tests that test component interactions
     - `tests/e2e/` - for end-to-end tests that test complete workflows
-    - `tests/test_pipelines/` - for test pipeline definitions (PLX files and their structuring python files)
 - Do NOT add `__init__.py` files to test directories. Test directories do not need to be Python packages.
 - Fixtures are defined in conftest.py modules at different levels of the hierarchy, their scope is handled by pytest
 - Test data is placed inside test_data.py at different levels of the hierarchy, they must be imported with package paths from the root like `from tests.integration.pipelex.cogt.test_data`. Their content is all constants, regrouped inside classes to keep things tidy.
@@ -294,11 +293,12 @@ NEVER EVER put more than one TestClass into a test module.
 #### Markers
 
 Apply the appropriate markers:
+- "gha_disabled: will not be able to run properly on GitHub Actions"
 - "llm: uses an LLM to generate text or objects"
 - "img_gen: uses an image generation AI"
 - "extract: uses text/image extraction from documents"
 - "inference: uses either an LLM or an image generation AI"
-- "gha_disabled: will not be able to run properly on GitHub Actions"
+- never add "@pytest.mark.dry_runnable" if you haven't set the "inference" marker
 
 Several markers may be applied. For instance, if the test uses an LLM, then it uses inference, so you must mark with both `inference`and `llm`.
 

.claude/commands/changelog.md

@@ -0,0 +1,33 @@
+# Update CHANGELOG.md (Unreleased)
+
+You will be given a block of “changes” immediately after this message (pasted by the user).
+Your job: update the repository changelog.
+
+## Target file
+- Prefer `CHANGELOG.md` at the repo root.
+- If not found, search the repo for a changelog file (common names: CHANGELOG.md, Changelog.md, changelog.md) and use the main one.
+
+## Rules (must follow)
+1) Keep existing formatting and conventions of the file.
+2) Update ONLY the `Unreleased` section:
+   - If a `## [Unreleased]` (or `## Unreleased`) section exists, merge the pasted changes into it.
+   - If it does not exist, create it near the top of the changelog:
+     - After the main title/introduction
+     - Before the first released version section
+3) Merge behavior:
+   - If the pasted changes already contain subsection headings like `### Added`, `### Changed`, `### Fixed`, etc., merge bullets under matching subsections in Unreleased.
+   - If a needed subsection doesn’t exist under Unreleased, create it.
+   - If the pasted changes do NOT include headings, classify each line into one of:
+     - Added / Changed / Deprecated / Removed / Fixed / Security
+     - Use best-effort classification by wording (add/introduce -> Added, fix/bug -> Fixed, remove/delete -> Removed, security/vuln -> Security, deprecate -> Deprecated, otherwise -> Changed)
+   - If onf of the pasted changes seems worthy of highlighting, propose to the user to do so and get their approval.
+4) De-duplicate:
+   - If a very similar bullet already exists in Unreleased, do not add it again.
+5) Preserve order:
+   - Keep the pasted changes in the order provided within each subsection.
+
+## Output
+- Make the minimal necessary edits to the changelog file.
+- When done, reply with:
+  - A brief summary of what you added (by subsection)
+  - The exact diff or the updated Unreleased section (whichever is shorter).

.claude/commands/docs-uth.md

@@ -0,0 +1,32 @@
+# Add a new page to the "Under the Hood" Documentation
+
+Explain the provided feature in the docs: add a new page to @docs/under-the-hood/
+
+Don't present the changes as "changes". Describe as if it were always like this. We are documenting the (new) current solution as the new normal.
+
+---
+Use our under-the-hood template:
+
+Structure: Principle → Usage variants → Interfaces → Architecture (Mermaid) → Implementation → Reference tables
+
+Approach:
+
+- Why before how
+
+- Exhaustive case tables (Scenario | Behavior)
+
+- Short code snippets (5-15 lines) for every concept
+
+- Factory-time vs runtime split when relevant
+
+- Interfaces section (if any) covers:
+  - CLI commands/flags
+  - API
+  - Inputs: expected types, sources, validation
+  - Outputs: return types, side effects, artifacts produced
+
+- !!! warning/info admonitions for gotchas
+
+Tone: Terse, declarative, jargon-friendly (assumes Pydantic/Jinja2 familiarity)
+
+Ends with: Syntax quick-ref + file→purpose table + "Next Steps" links

.cursor/rules/commands.mdc

@@ -16,7 +16,7 @@ description: Guidelines for running commands
 
    This runs multiple code quality tools:
    - Pyright: Static type checking
-   - Ruff: Fix unised imports, lint, format  
+   - Ruff: Fix unused imports, lint, format  
    - Mypy: Static type checker
 
    Always fix any issues reported by these tools before proceeding.

.cursor/rules/pytest_standards.mdc

@@ -18,7 +18,6 @@ NEVER EVER put more than one TestClass into a test module.
     - `tests/unit/` - for unit tests that test individual functions/classes in isolation
     - `tests/integration/` - for integration tests that test component interactions
     - `tests/e2e/` - for end-to-end tests that test complete workflows
-    - `tests/test_pipelines/` - for test pipeline definitions (PLX files and their structuring python files)
 - Do NOT add `__init__.py` files to test directories. Test directories do not need to be Python packages.
 - Fixtures are defined in conftest.py modules at different levels of the hierarchy, their scope is handled by pytest
 - Test data is placed inside test_data.py at different levels of the hierarchy, they must be imported with package paths from the root like `from tests.integration.pipelex.cogt.test_data`. Their content is all constants, regrouped inside classes to keep things tidy.
@@ -29,11 +28,12 @@ NEVER EVER put more than one TestClass into a test module.
 ### Markers
 
 Apply the appropriate markers:
+- "gha_disabled: will not be able to run properly on GitHub Actions"
 - "llm: uses an LLM to generate text or objects"
 - "img_gen: uses an image generation AI"
 - "extract: uses text/image extraction from documents"
 - "inference: uses either an LLM or an image generation AI"
-- "gha_disabled: will not be able to run properly on GitHub Actions"
+- never add "@pytest.mark.dry_runnable" if you haven't set the "inference" marker
 
 Several markers may be applied. For instance, if the test uses an LLM, then it uses inference, so you must mark with both `inference`and `llm`.
 

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,6 @@
 blank_issues_enabled: false
 contact_links:
+  # PRERELEASE_LINK (discussions are repo-level, not branch-specific - no URL change needed)
   - name: 💡 Pipeline requests
     url:  https://github.com/Pipelex/pipelex-cookbook/discussions/categories/ideas
     about: "Please start an Idea Discussion in the Cookbook."

.github/copilot-instructions.md

@@ -15,7 +15,7 @@
 
    This runs multiple code quality tools:
    - Pyright: Static type checking
-   - Ruff: Fix unised imports, lint, format  
+   - Ruff: Fix unused imports, lint, format  
    - Mypy: Static type checker
 
    Always fix any issues reported by these tools before proceeding.
@@ -283,7 +283,6 @@ NEVER EVER put more than one TestClass into a test module.
     - `tests/unit/` - for unit tests that test individual functions/classes in isolation
     - `tests/integration/` - for integration tests that test component interactions
     - `tests/e2e/` - for end-to-end tests that test complete workflows
-    - `tests/test_pipelines/` - for test pipeline definitions (PLX files and their structuring python files)
 - Do NOT add `__init__.py` files to test directories. Test directories do not need to be Python packages.
 - Fixtures are defined in conftest.py modules at different levels of the hierarchy, their scope is handled by pytest
 - Test data is placed inside test_data.py at different levels of the hierarchy, they must be imported with package paths from the root like `from tests.integration.pipelex.cogt.test_data`. Their content is all constants, regrouped inside classes to keep things tidy.
@@ -294,11 +293,12 @@ NEVER EVER put more than one TestClass into a test module.
 #### Markers
 
 Apply the appropriate markers:
+- "gha_disabled: will not be able to run properly on GitHub Actions"
 - "llm: uses an LLM to generate text or objects"
 - "img_gen: uses an image generation AI"
 - "extract: uses text/image extraction from documents"
 - "inference: uses either an LLM or an image generation AI"
-- "gha_disabled: will not be able to run properly on GitHub Actions"
+- never add "@pytest.mark.dry_runnable" if you haven't set the "inference" marker
 
 Several markers may be applied. For instance, if the test uses an LLM, then it uses inference, so you must mark with both `inference`and `llm`.
 

.github/workflows/changelog-check.yml

@@ -4,35 +4,30 @@ on:
   pull_request:
     branches:
       - main
+      - 'pre-release/v*'
     types: [opened, synchronize, reopened]
 
 jobs:
   check-changelog:
     runs-on: ubuntu-latest
-    if: startsWith(github.head_ref, 'release/v')  # Only run on release branches
     steps:
       - uses: actions/checkout@v4
 
       - name: Check Changelog Version
         run: |
-          # Get the current branch name and extract version
-          BRANCH_NAME=${GITHUB_HEAD_REF}
-          
-          if [[ $BRANCH_NAME =~ ^release/v([0-9]+\.[0-9]+\.[0-9]+)$ ]]; then
-            VERSION="${BASH_REMATCH[1]}"
-            echo "Checking release branch v$VERSION against changelog..."
-            
-            # Look for the version in the changelog
-            if ! grep -q "## \[v$VERSION\] -" CHANGELOG.md; then
-              echo "❌ Error: No changelog entry found for version v$VERSION"
-              echo "The following versions are in the changelog:"
-              grep -E "^## \[v[0-9]+\.[0-9]+\.[0-9]+\]" CHANGELOG.md
-              echo "Please add a changelog entry for v$VERSION before merging this release to main"
-              exit 1
-            else
-              echo "✅ Changelog entry found for version v$VERSION"
-            fi
-          else
-            echo "❌ Error: Branch name $BRANCH_NAME does not match expected format 'release/vX.Y.Z'"
+          # Get version from pyproject.toml
+          VERSION=$(grep -m 1 'version = ' pyproject.toml | cut -d '"' -f 2)
+          echo "Version from pyproject.toml: $VERSION"
+
+          # Look for the version in the changelog
+          if ! grep -q "## \[v$VERSION\] -" CHANGELOG.md; then
+            echo "❌ Error: No changelog entry found for version v$VERSION"
+            echo ""
+            echo "The following versions are in the changelog:"
+            grep -E "^## \[v[0-9]+" CHANGELOG.md | head -10
+            echo ""
+            echo "Please add a changelog entry: ## [v$VERSION] - YYYY-MM-DD"
             exit 1
-          fi 
+          else
+            echo "✅ Changelog entry found for version v$VERSION"
+          fi

.github/workflows/deploy-docs.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - pre-release/v*
 
 permissions:
   contents: write
@@ -41,4 +42,11 @@ jobs:
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
 
       - name: Deploy documentation
-        run: make docs-deploy-stable
+        run: |
+          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+            echo "Deploying stable docs..."
+            make docs-deploy-stable
+          elif [[ "${{ github.ref }}" == refs/heads/pre-release/* ]]; then
+            echo "Deploying beta docs..."
+            make docs-deploy-beta
+          fi