Merge pull request #870 from opsmill/wvd-20260316-prep-release-1.19

prepare release v1.19.0

Author: wvandeun

.github/file-filters.yml

@@ -36,7 +36,8 @@ markdown_all: &markdown_all
 
 infrahub_reference_generated: &infrahub_reference_generated
   - "docs/docs/infrahubctl/*.mdx"
-  - "docs/docs/python-sdk/reference/config.mdx"
+  - "docs/docs/python-sdk/reference/*.mdx"
+  - "docs/docs/python-sdk/sdk_ref/**/*.mdx"
 
 documentation_all:
   - *development_files

.github/workflows/ci.yml

@@ -108,7 +108,7 @@ jobs:
       - name: "Linting: markdownlint"
         uses: DavidAnson/markdownlint-cli2-action@v22
         with:
-          config: .markdownlint.yaml
+          config: docs/.markdownlint.yaml
           globs: |
             **/*.{md,mdx}
             !changelog/*.md
@@ -176,7 +176,7 @@ jobs:
         uses: actions/setup-node@v5
         with:
           node-version: 20
-          cache: 'npm'
+          cache: "npm"
           cache-dependency-path: docs/package-lock.json
       - name: "Install dependencies"
         run: npm install
@@ -207,6 +207,15 @@ jobs:
         uses: "actions/checkout@v6"
         with:
           submodules: true
+      - name: Install NodeJS
+        uses: actions/setup-node@v5
+        with:
+          node-version: 20
+          cache: "npm"
+          cache-dependency-path: docs/package-lock.json
+      - name: "Install npm dependencies"
+        run: npm install
+        working-directory: ./docs
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
@@ -217,9 +226,11 @@ jobs:
           version: "${{ needs.prepare-environment.outputs.UV_VERSION }}"
       - name: Install dependencies
         run: uv sync --all-groups --all-extras
+      - name: Docs unit tests
+        run: npx --no-install vitest run
+        working-directory: ./docs
       - name: Validate generated documentation
         run: uv run invoke docs-validate
-
   validate-documentation-style:
     if: |
       always() && !cancelled() &&
@@ -236,6 +247,7 @@ jobs:
 
       # The official GitHub Action for Vale doesn't work, installing manually instead:
       # https://github.com/errata-ai/vale-action/issues/103
+      # cf -> https://github.com/nf-core/website/pull/3509
       - name: Download Vale
         run: |
           curl -sL "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" -o vale.tar.gz

.github/workflows/sync-docs.yml

@@ -8,8 +8,9 @@ on:
       - stable
     paths:
       - 'docs/docs/**'
-      - 'docs/sidebars-infrahubctl.ts'
-      - 'docs/sidebars-python-sdk.ts'
+      - 'docs/sidebars/sidebars-infrahubctl.ts'
+      - 'docs/sidebars/sidebars-python-sdk.ts'
+      - 'docs/sidebars/sidebar-utils.ts'
 
 jobs:
   sync:
@@ -33,8 +34,9 @@ jobs:
           rm -f target-repo/docs/sidebars-python-sdk.ts
           rm -f target-repo/docs/sidebars-infrahubctl.ts
           cp -r source-repo/docs/docs/* target-repo/docs/docs-python-sdk/
-          cp source-repo/docs/sidebars-infrahubctl.ts target-repo/docs/
-          cp source-repo/docs/sidebars-python-sdk.ts target-repo/docs/
+          cp source-repo/docs/sidebars/sidebars-infrahubctl.ts target-repo/docs/
+          cp source-repo/docs/sidebars/sidebars-python-sdk.ts target-repo/docs/
+          cp source-repo/docs/sidebars/sidebar-utils.ts target-repo/docs/
           cd target-repo
           git config user.name github-actions
           git config user.email github-actions@github.com

.vale.ini

@@ -23,3 +23,10 @@ BasedOnStyles =
 
 [*]
 BasedOnStyles = Infrahub
+
+# Generated API reference docs: use GeneratedRef spelling (allows snake_case)
+# instead of global Infrahub spelling. Must be last to override [*].
+[docs/docs/python-sdk/sdk_ref/**/*.mdx]
+BasedOnStyles = Infrahub, GeneratedRef
+Infrahub.spelling = NO
+BlockIgnores = (?s) *((import.*?\n)|(```.*?```\n))

.vale/styles/GeneratedRef/spelling.yml

@@ -0,0 +1,10 @@
+---
+extends: spelling
+message: "Did you really mean '%s'?"
+level: error
+filters:
+  - '[pP]y.*\b'
+  - '\bimport_.*\b' # Ignore variables starting with 'import_'
+  - '\w+__value' # Skip Infrahub filters in documentation (name__value)
+  - '\b\w+_\w+\b' # Ignore snake_case identifiers in generated API reference docs
+ignore: spelling-exceptions.txt

.vale/styles/Infrahub/sentence-case.yml

@@ -52,6 +52,7 @@ exceptions:
   - Jinja
   - Jinja2
   - JWT
+  - MDX
   - Namespace
   - NATS
   - Node

.vale/styles/Infrahub/spelling.yml

@@ -4,6 +4,6 @@ message: "Did you really mean '%s'?"
 level: error
 filters:
   - '[pP]y.*\b'
-  - '\bimport_.*\b' # New filter to ignore variables starting with 'import_'
-  - '\w+__value' # New filter to skip Infrahub filters in documentation (name__value)
+  - '\bimport_.*\b' # Ignore variables starting with 'import_'
+  - '\w+__value' # Skip Infrahub filters in documentation (name__value)
 ignore: spelling-exceptions.txt

.vale/styles/spelling-exceptions.txt

@@ -3,6 +3,7 @@ Alibaba
 Ansible
 append_git_suffix
 APIs
+Args
 artifact_definitions
 artifact_name
 async
@@ -78,6 +79,7 @@ kbps
 Keycloak
 Loopbacks
 markdownlint
+MDX
 max_count
 memgraph
 menu_placement

AGENTS.md

@@ -7,8 +7,10 @@ Infrahub Python SDK - async/sync client for Infrahub infrastructure management.
 ```bash
 uv sync --all-groups --all-extras   # Install all deps
 uv run invoke format                # Format code
-uv run invoke lint                  # All linters (code + yamllint + documentation)
+uv run invoke lint                  # Full pipeline: ruff, yamllint, ty, mypy, markdownlint, vale
 uv run invoke lint-code             # All linters for Python code
+uv run invoke docs-generate         # Generate all docs (CLI + SDK)
+uv run invoke docs-validate         # Check generated docs match committed version
 uv run pytest tests/unit/           # Unit tests
 uv run pytest tests/integration/    # Integration tests
 ```
@@ -54,7 +56,7 @@ Key rules:
 ✅ **Always**
 
 - Run `uv run invoke format lint-code` before committing Python code
-- Run `uv run invoke generate-sdk generate-infrahubctl` after changing CLI commands or SDK config
+- Run `uv run invoke docs-generate` after creating, modifying or deleting CLI commands, SDK config, or Python docstrings
 - Run markdownlint before committing markdown changes
 - Follow async/sync dual pattern for new features
 - Use type hints on all function signatures

CHANGELOG.md

@@ -10,6 +10,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in <https://github.com/opsmill/infrahub/tree/develop/infrahub/python_sdk/changelog/>.
 
 <!-- towncrier release notes start -->
+
+## [1.19.0](https://github.com/opsmill/infrahub-sdk-python/tree/v1.19.0) - 2026-03-16
+
+### Added
+
+- Added support for FileObject nodes with file upload and download capabilities. New methods `upload_from_path(path)` and `upload_from_bytes(content, name)` allow setting file content before saving, while `download_file(dest)` enables downloading files to memory or streaming to disk for large files. ([#ihs193](https://github.com/opsmill/infrahub-sdk-python/issues/ihs193))
+- Python SDK API documentation is now generated directly from the docstrings of the classes, functions, and methods contained in the code. ([#201](https://github.com/opsmill/infrahub-sdk-python/issues/201))
+- Added a 'py.typed' file to the project. This is to enable type checking when the Infrahub SDK is imported from other projects. The addition of this file could cause new typing issues in external projects until all typing issues have been resolved. Adding it to the project now to better highlight remaining issues.
+
+### Changed
+
+- Updated branch report command to use node metadata for proposed change creator information instead of the deprecated relationship-based approach. Requires Infrahub 1.7 or above.
+
+### Fixed
+
+- Allow SDK tracking feature to continue after encountering delete errors due to impacted nodes having already been deleted by cascade delete. ([#265](https://github.com/opsmill/infrahub-sdk-python/issues/265))
+- Fixed Python SDK query generation regarding from_pool generated attribute value ([#497](https://github.com/opsmill/infrahub-sdk-python/issues/497))
+
 ## [1.18.1](https://github.com/opsmill/infrahub-sdk-python/tree/v1.18.1) - 2026-01-08
 
 ### Fixed