78 Commits
Author SHA1 Message Date
Stefano Fiorucci 6ca8349091 chore: refine AGENTS.md for docs changes (#13168) 2026-10-07 18:31:34 +02:00
Stefano Fiorucci 8de1258198 ci: fix wait_for_workflows release script (#12925) 2026-09-24 15:26:32 +02:00
Stefano Fiorucci 45132a091f ci: fix docs search sync for 3.x (#12402) 2026-08-19 10:26:05 +02:00
Stefano Fiorucci 3765bab785 docs: keep the number of docs versions constant (#12395) 2026-08-18 13:35:57 +00:00
88db3cd150 Release workflow update (#12241)
Co-authored-by: Julian Risch <[email protected]>
Co-authored-by: Claude Sonnet 5 <[email protected]>
2026-08-05 09:25:41 +02:00
Stefano Fiorucci 5d101e5a80 ci: adapt workflows in preparation for 3.0 (#12026) 2026-07-16 10:37:16 +02:00
bogdankostic 3f049209b1 ci: rename DC_PIPELINE_IMAGES_PR_URL to HAYSTACK_RUNTIME_PR_URL (#11807) 2026-06-29 13:46:46 +02:00
Yiyao WeiandClaude Opus 4.8 d81d742805 ci: dispatch haystack version bump to haystack-runtime instead of archived dc-pipeline-images (#11719)
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-22 17:55:43 +02:00
Kacper ŁukawskiandStefano Fiorucci d831f54f0c feat: add redirects for inactive documentation versions in vercel.json (#11027)
* feat: add redirects for inactive documentation versions in vercel.json

* Update .github/utils/promote_unstable_docs_docusaurus.py

Co-authored-by: Stefano Fiorucci <[email protected]>

* fix: remove try/except block as file has to exist

---------

Co-authored-by: Stefano Fiorucci <[email protected]>
2026-04-02 16:04:12 +02:00
Stefano Fiorucci 1bce8ef0a7 ci: automate Platform testing during Haystack release (#10924)
* draft

* temp changes for testing

* fix version number

* fix filename

* another fix

* notification

* try with DC custom nodes

* fix/simplify script

* try DC_PIPELINE_IMAGES

* try future release number

* refine release notification

* remove testing temp

* refinements

* refinements

* no draft
2026-03-26 11:06:35 +01:00
Julian RischandClaude Sonnet 4.6 6c7348023b chore: enable ANN ruff ruleset for type annotation enforcement (#10856)
* chore: enable ANN ruff ruleset, exclude components and testing dirs

- Add ANN (flake8-annotations) to ruff select in pyproject.toml
- Globally ignore ANN401 (Any) for legitimate dynamic types
- Exclude haystack/components/** and haystack/testing/** from ANN checks
  (mirrors existing mypy disallow_incomplete_defs=false overrides)
- Fix all 43 ANN violations in the remaining modules:
  - Add -> None to __post_init__ in breakpoints, file_content,
    image_content, sparse_embedding, streaming_chunk, tool, toolset, auth
  - Add -> str to __str__ in filter_policy, auth, hf (2x)
  - Add *args: Any, **kwargs: Any + return types to metaclass __call__
    in component.py and document.py, and __new__ in chat_message.py
  - Add -> None to async _runner() in async_pipeline.py
  - Type _check_callable_compatibility args and return bool
  - Add Callable return type to _dispatch_bm25
  - Type send_telemetry decorator params and return
  - Type __init_track__ and __setattr_warn__ wrapper functions
  - Type _parse_date, _parse_generic_args, async run()

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* chore: fix ANN violations in .github/utils and docs-website scripts

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* chore: fix mypy errors introduced by ANN annotations

- async_pipeline.py: _runner() returns Mapping[str, Any], not None
- dataclasses.py: extend type: ignore to cover arg-type in addition to call-arg

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* alphabetical order of ruff rules

* fix: add ANN type annotations to haystack/components and remove per-file-ignore

Fix all ANN (flake8-annotations) violations in haystack/components/ so
the per-file-ignore for that directory can be removed entirely.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* chore: remove haystack.components.* from mypy disallow_incomplete_defs override

All ANN type annotations have been added to haystack/components/, so the
mypy override is no longer needed for that module.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

---------

Co-authored-by: Claude Sonnet 4.6 <[email protected]>
2026-03-18 11:28:33 +00:00
Stefano Fiorucci 5534c72f7e ci: add workflow to check correct API reference generation (#10843)
* ci: add workflow to check correct API reference generation

* trigger in docstring

* rm trigger
2026-03-17 11:37:24 +01:00
Stefano Fiorucci a490409a46 ci: simplify GitHub-Slack communication in the release process (#10739) 2026-03-05 11:48:45 +01:00
Stefano Fiorucci 34a2e7585c docs: improve create_unstable_docs_docusaurus.py script (#10685)
* draft

* improve

* simplify and improve
2026-02-27 11:44:21 +01:00
Stefano Fiorucci 819ed7244b chore: drop pylint (#10640)
* draft

* progress

* more fixes

* improvs

* strict

* rm pylint

* rm pylint comments

* fix and simplify

* standardize

* more

* alpha order

* final touch

* remove template

* rm ellipsis comments
2026-02-24 07:46:20 +00:00
Stefano Fiorucci 642ea68d5f docs: simplify API reference config and remove script (#10617) 2026-02-18 12:01:18 +01:00
Stefano Fiorucci 8091034fb5 chore: remove unused imports and enforce related Ruff rule (#10278)
* chore: remove unused imports and enforce ruff rule

* fix

* enforce f401 rule

* pylint fix
2025-12-19 18:45:44 +01:00
Stefano Fiorucci 7c6323b960 refactor: support PEP604 typing syntax (X|Y and X|None) (#10255)
* adopt X|Y syntax: draft

* cast Union

* fix pylint + state testing

* use X|Y

* rm unused imports

* trigger e2e tests

* fix + simplification

* add compatibility tests

* rm e2e tests trigger

* fix

* add relnote

* simplify/fix pep604 union parsing

* fix comments

* test _is_optional_type

* introduce _build_pep604_union_type; make _is_union_type private

* try removing problematic test
2025-12-19 15:47:51 +01:00
Stefano Fiorucci 3b4f4ac7e9 ci: Release orchestration workflow (#10233)
* ci: release orchestration workflow

* offload notification preparation to external script

* swap if/needs

* slim where makes sense

* tmp test for ubuntu slim

* revet

* concurrency
2025-12-12 16:30:02 +01:00
Stefano Fiorucci 0205781af1 ci: add scripts for release automation (#10226)
* ci: add scripts for release automation

* improvements from review
2025-12-11 17:06:24 +01:00
Stefano Fiorucci af75774c3f chore: rename docs directory and other adjustments (#10157)
* chore: rename docs directory and other adjustments

* fixes
2025-11-28 08:41:35 +01:00
Stefano Fiorucci 8bdcd34610 chore: remove CI scripts and configs for Readme API (#10147) 2025-11-27 13:05:55 +01:00
Stefano Fiorucci 40daaf6cf5 ci: workflow to populate the index to search docs (#10132)
* try feed docs search

* fix

* checkout

* update

* start developing workflow

* fix dir

* tru

* fix lint

* progress

* fixes

* more fixes

* improve script

* refinements

* install requests

* small improvements

* use npm install

* further refinements

* run this workflow manually and scheduled

* fmt

* try monitor

* retry

* clean up
2025-11-26 09:28:33 +00:00
Stefano Fiorucci 244dd824cb docs: CI scripts for docs versioning at Haystack release (#9980)
* draft

* progress

* progress

* todo comments

* refinements
2025-10-31 10:46:44 +01:00
Stefano Fiorucci d77a853b49 chore: remove unused files (#9876) 2025-10-15 09:48:37 +02:00
Abdelrahman Kasebandanakin87 5f3c37d287 chore: adopt PEP 585 type hints (#9678)
* chore(lint): enforce and apply PEP 585 type hinting

* Run fmt fixes

* Fix all typing imports using some regex

* Fix all typing written in string in tests

* undo changes in the e2e tests

* make e2e test use list instead of List

* type fixes

* remove type:ignore

* pylint

* Remove typing from Usage example comments

* Remove typing from most of comments

* try to fix e2e tests on comm PRs

* fix

* Add tests typing.List in to adjust test compatiplity
- test/components/agents/test_state_class.py
- test/components/converters/test_output_adapter.py
- test/components/joiners/test_list_joiner.py

* simplify pyproject

* improve relnote

---------

Co-authored-by: anakin87 <[email protected]>
2025-08-07 10:23:14 +02:00
Stefano FiorucciandSebastian Husch Lee c18f81283c chore: fix deepset_sync.py for pylint + general linting improvements (#9558)
* chore: fix deepset_sync.py for pylint

* check .github with ruff

* fix

* Update .github/utils/pyproject_to_requirements.py

Co-authored-by: Sebastian Husch Lee <[email protected]>

---------

Co-authored-by: Sebastian Husch Lee <[email protected]>
2025-06-27 07:54:22 +00:00
mathislucka 101e9cdc34 docs: sync code to deepset workspace (#9555)
* docs: sync code to deepset workspace

* fix: naming

* fix: actionlint
2025-06-27 07:51:59 +02:00
Michele Pangrazzi 3207a76d50 chore: Update pydoc-markdown.sh (#9547)
* Make config path a $1 param ; Add usage in comment ; Add echo log

* Update sync command
2025-06-24 14:01:51 +02:00
Stefano Fiorucci 3339097e99 ci: refactor job to check imports (#8892)
* refactor

* Trigger CI

* run tests if this file changes

* show failure

* revert

* rm duplicate subdir and explain in comment
2025-02-21 11:37:41 +01:00
Stefano Fiorucci 09adf856dc rm openapi spec util (#8613) 2024-12-09 10:59:21 +01:00
Stefano FiorucciandMadeesh Kannan de7099e560 ci: add job to check imports (#8594)
* try checking imports

* clarify error message

* better fmt

* do not show complete list of successfully imported packages

* refinements

* relnote

* add missing forward references

* better function name

* linting

* fix linting

* Update .github/utils/check_imports.py

Co-authored-by: Madeesh Kannan <[email protected]>

---------

Co-authored-by: Madeesh Kannan <[email protected]>
2024-11-29 14:00:59 +00:00
Silvano Cerza 9dc602ebf3 Remove type hint (#8367) 2024-09-16 11:50:56 +02:00
Silvano CerzaandMadeesh Kannan 145dfce3aa ci: Slightly rework docs release process (#8363)
* Slightly rework docs release process

* Apply suggestions from code review

Co-authored-by: Madeesh Kannan <[email protected]>

---------

Co-authored-by: Madeesh Kannan <[email protected]>
2024-09-16 09:28:40 +00:00
Silvano Cerza 2fea67d4a9 Fix delete_outdated_docs.py to get the correct api key (#7242) 2024-02-28 12:52:13 +01:00
Silvano Cerza 85491433c6 ci: Add script to delete documentation that don't exist anymore (#7209)
* Add script to delete documentation that don't exist anymore

* Remove prints
2024-02-28 11:02:59 +01:00
Massimiliano Pippi 4efe40664c use haystack-pydoc-tools package instead of local code (#6818) 2024-01-23 18:28:52 +01:00
Daria Fokina 3fedd9f67f docs: add Data Classes API ref and cleanup (#6482)
* Data Classes and cleanup

* Update pydoc-markdown.sh

* Update converter.yml
2023-12-04 14:03:28 +01:00
Julian Risch db36d6277a docs: Add readme sync for API docs 2.0 (#6173)
* add sync docs for preview

* add example config for audio docs

* hardcode version in renderer

* use custom renderer for preview docs

* update comment and excerpt
2023-10-27 14:53:03 +02:00
Massimiliano Pippi 428096733d ci: add a job to vet license of direct dependencies only (#4885)
* add conversion script

* run job in CI

* typo

* invoke python

* install toml

* fix pylint error

* more exclusions

* add toml to dev dependencies

* fix exclusions list

* fix mypy and remove test clause
2023-05-12 11:20:48 +02:00
Silvano Cerza 4cc69eeb29 Fix release_docs.py to create docs with correct version (#4803) 2023-05-03 15:04:50 +02:00
Silvano Cerza dbdb682225 Enhance release_docs.py (#4459) 2023-03-28 09:56:42 +02:00
Massimiliano Pippi 1498aacc77 chore: make the docs generator runnable without an API key (#4405)
* spit a warning instead of exiting

* print which file is being converted (useful to debug CI)

* pin docspec for the time being
2023-03-14 16:15:19 +01:00
Silvano Cerza ee74421212 ci: Refactor docs config and generation (#4280)
* Change docs yml category config

* Update docs renderers to fetch categories from Readme.io

* Update readme_sync.yml to handle new docs rendering

* Remove unecessary script and related workflow step

* Fix sys.exits
2023-03-01 09:51:02 +01:00
Silvano Cerza 181e5474e8 ci: Automate OpenAPI specs upload to Readme.io (#4228)
* Remove OpenAPI specs file

* OpenAPI specs are now automatically uploaded when necessary

* Rename openapi workflow
2023-02-22 18:01:18 +01:00
Silvano Cerza 689f2cd250 Update docstring-labeler.yml workflow to safely run in PRs from forks (#4146) 2023-02-16 16:02:41 +01:00
Silvano Cerza 2cc938ff90 ci: Add workflow to label PRs that edit docstrings (#4115)
* Add workflow to label PRs that edit docstrings

* Add python-version arg in setup-python steps

* Run workflow only in haystack and rest_api python files edit

* Fix labeling job

* Fix labeling conditional

* Fix files globbing in docstrings_checksum.py

* Fix typing

* Rework workflow to use a single job
2023-02-09 18:57:30 +01:00
Massimiliano Pippi 8824f3a10a re-organize pydoc config files (#4042) 2023-02-03 12:51:10 +01:00
Bilge Yücel ddba75021a fix: add additional settings to OpenAPI schema (#3788)
* "proxy-enabled": disable CORS proxy
* "samples-languages": display two languages initially
2022-12-30 16:10:37 +03:00
bogdankostic 36cfd41713 Add newline when generating OpenAPI specs (#3782) 2022-12-29 17:55:43 +01:00